API em NodeJS e Express.js para o Back-End do projeto.
- NodeJS v16.13;
- Yarn;
- TypeScript;
- PostgreSQL;
- JavaScript.
Este é um passo a passo para a realição de uma instalação local da aplicação; A instalação em um servidor web poderá variar de acordo com o provedor utilizado para a hospedagem.
- Crie um diretório local e clone o repositório:
$ mkdir backend
$ cd backend
$ git clone https://github.com/IF-Control/app-backend.git .
-
Copie o arquivo .env.example e renomeie-o para .env e cole novamente o arquivo .env.example. Agora, configure nele a sua chave do JWT, a conexão com o banco de dados, a porta em que o serviço vai rodar e a timezone desejada.
-
Para criar a migration e poder utilizar o banco de dados no servidor local rode o seguinte comando:
$ yarn prisma migrate dev
- Para rodar a aplicação, digite a sequência de comandos em seu terminal:
$ yarn install
$ yarn dev
Se algo não está funcionando corretamente, isso é um bug e deve ser reportado.
Reporte aqui um bug ou erro por meio das issues.
Todas as contribuições são bem-vindas. Sugerimos usar este workflow:
- Faça um Fork no projeto;
- Crie um branch:
git checkout -b nome_da_branch; - Faça a sua adição de funcionalidade ou correção de bug e faça o commit:
git commit -m 'mensagem_descritiva_do_commit'; - Envie uma Pull Request com a descrição do seu trabalho.
© Copyright 2022 IF Control, Débora Miyake & Victor Sousa.
Lançado com a licença MIT.