Skip to content

fga-eps-mds/2020.1-Minacademy-BackEnd

Repository files navigation

Minacademy Backend

Maintainability Test Coverage

Quality Gate Status Code Smells Maintainability Rating Reliability Rating Security Rating

Lines of Code Duplicated Lines (%)

Repositório do BackEnd do projeto Minacademy.

Executando o projeto

  • Instale o Docker e o Compose no seu computador

  • Baixe este repositório e entre na pasta baixada

  • Se essa é a primeira vez que está rodando o projeto, execute make build

  • Se já rodou o projeto antes, execute make run

  • Rode o frontend do projeto. Saiba mais aqui

  • Se você fez os passos acima e não houve nenhum erro, o projeto já está rodando em localhost:3000 =D

Instalação de Pacotes

Se você deseja instalar um pacote utilizando npm, leia as instruções a seguir:

  • Execute o comando make npm pacote=<nome-do-pacote>
  • Se for uma dependência apenas para desenvolvimento execute make npm-dev pacote=<nome-do-pacote>

Comandos Úteis

Comando Descrição
make start Inicia o container quando este está pausado
make stop Pausa a execução do container
make list Lista os containers em execução
docker-compose exec server <comando> Executa um comando dentro do container

Seeds

O projeto já está configurado para popular o banco assim que o container é iniciado. Caso queira popular novas models, crie um arquivo .json dentro da pasta seeds/ que popula a nova model. Utilize o arquivo users.json como exemplo e faça um arquivo por model.

Documentação

A documentação desse projeto pode ser acessada aqui.