🚧 README customizado em construção ! 🚧

Índice

1. Sobre o Projeto
   • Construido Com
2. Começando
   • Instalação
   • Configurando
   • Executando
3. Uso
4. Contato
5. Agradecimentos

Sobre o Projeto

...

(voltar ao topo)

Construido Com

Back-end

• 
• 
• 
• 
• 
• 
• 
• 
• 

(voltar ao topo)

Começando

Instalação

1. Clonar o repositorio

git clone [email protected]:RenanFernandess/trybe-project-trybe-futebol-clube.git

2. Entrar na pasta trybe-project-trybe-futebol-clube

cd ./trybe-project-trybe-futebol-clube

Configurando

Docker

É necessário utilizar o Docker Compose para rodar a aplicação

1. Iniciar o Docker Compose

npm run compose:up

Para finalizar o Docker Compose execute o comando:

npm run compose:down

Database

Ambiente

Configurar as variáveis de ambiente.

1. Criar arquivo .env

touch ./app/backend/.env

2. Adicionar as variáveis no arquivo .env

JWT_SECRET=jwt_secret
APP_PORT=3001
DB_USER=root
DB_PASS=123456
DB_HOST=localhost
DB_PORT=3002

Você pode seguir como exemplo o arquivo .env.example na pasta back-end.

Executando

A aplicação é iniciada automaticamente junto com os containers do Compose.

• Para testar a página da aplicação em seu navegador utilize a seguinte URL:

  http://127.0.0.1:3000/
  

• URL da API (Back-end):

  http://127.0.0.1:3001/
  

(voltar ao topo)

Uso

Front-end

Back-end

Scripts

(voltar ao topo)

Contato

• Renan Fernandes - Linkedin - GitHub - [email protected]

(voltar ao topo)

Agradecimentos

• Trybe
• Best-README-Template

(voltar ao topo)