Skip to content

Latest commit

 

History

History
87 lines (55 loc) · 2.86 KB

README.md

File metadata and controls

87 lines (55 loc) · 2.86 KB
Raw

DJ Backend Template

Este é um template para criar backend APIs em NodeJS seguindo as melhores práticas de desenvolvimento que aprendi ao longo dos anos.

👨🏼‍💻 PROGRAMADORes

🚀 Tecnologias

  • ⚡ NodeJS
  • ✨ Express
  • 💾 Sequelize
  • 🐘 PostgreSQL

Pré-requisitos

Instalação

  1. Clone este repositório
  2. Execute yarn para instalar as dependências
  3. Crie um arquivo .env com as variáveis de ambiente necessárias (veja .env.example para um exemplo)
  4. Execute yarn dev para iniciar o servidor em modo de desenvolvimento

Scripts disponíveis

  • yarn dev: inicia o servidor em modo de desenvolvimento
  • yarn start: inicia o servidor em modo de produção
  • yarn att: atualiza as dependências para as versões mais recentes

Estrutura de pastas

  • api/config: arquivos de configuração
  • api/controllers: controladores que lidam com as requisições HTTP
  • api/database: arquivos relacionados ao banco de dados
  • api/models: modelos de dados relacionados ao banco de dados
  • api/routes: rotas da API
  • api/utils: funções utilitárias
  • api/server.js: arquivo principal do servidor
  • api/api.js: arquivo que define a configuração e inicialização da API

Contribuindo

Contribuições são bem-vindas! Sinta-se à vontade para abrir uma issue ou enviar um pull request.

Licença

Este projeto está licenciado sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

Para utilizar este template

  • Utilize a linha de comando abaixo para clonar este repositorio
git clone https://github.com/djedu28/dj-backend-template.git dj-backend
  • Adicione pelo menos os elementos abaixo no seu README.md
## Baseado no Template: [DJ Backend Template](https://github.com/djedu28/dj-backend-template)

O `DJ Backend Template` é um template para criar backend APIs em NodeJS seguindo as melhores práticas de desenvolvimento.

Desenvolvido por [Eduardo Santos (@DjEdu28)](https://github.com/djedu28)

### Contribuindo

Contribuições são bem-vindas! Sinta-se à vontade para abrir uma issue ou enviar um pull request para [DJ Backend Template](https://github.com/djedu28/dj-backend-template)

<https://github.com/djedu28/dj-backend-template>

### Licença de `DJ Backend Template`

O projeto `DJ Backend Template` está licenciado sob a licença MIT. Veja o arquivo [LICENSE](https://github.com/djedu28/dj-backend-template/blob/master/LICENSE.md)  para mais detalhes.