Servidor da aplicação de entrega da merenda escolar do IFPE - Campus Recife.
O projeto é feito em Node.js utilizando bibliotecas como o Express e o Prisma.
A documentação da API pode ser encontrada aqui.
Caso ocorra algum problema, existe também uma versão em Swagger UI.
O arquivo OpenAPI da API pode ser encontrado em /docs/swagger.yaml.
- Verifique se você tem o Node.js e o Docker instalados;
- Suba o banco de dados com o comando
docker-compose up -d; - Instale as dependências com o comando
npm install; - Duplique o arquivo
.env.examplee renomeie para.env; - Nele, preencha as variáveis de ambiente com os valores corretos do banco de dados;
- Execute as migrations com o comando
npx prisma migrate dev; - Rode o servidor com o comando
npm run dev.
Este projeto é mantido por esses incríveis contribuidores.
Contribuições, issues e pedidos de features são bem-vindos!
Sinta-se livre para checar a página de issues.
- Crie um fork;
- Crie um branch com a sua feature:
git checkout -b minha-feature; - Faça um commit com as mudanças:
git commit -m 'feat: Minha nova feature'; - Faça um push para o seu branch:
git push origin minha-feature. - Abra uma pull request.
Após a sua pull request ser aceita, você pode excluir o seu branch.
Dê uma ⭐️ se este projeto lhe ajudou!
Este projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.
Feito com ♥ no 
IFPE Open Source