Modular Layer API Node + TypeScript

Descrição

Este é um modelo base para uma API modular em camadas utilizado no módulo de NodeJS da turma do Comeia Academy 2023, escrito utilizando NodeJS com Typescript.

Configuração

Para configurar este projeto localmente, siga estas etapas:

1. Clone o repositório: git clone https://github.com/comeia-academy/modular-layer-api-node-ts.git

2. Crie um arquivo .env na raiz do projeto e preencha as seguintes variáveis:

DB_HOST=
DB_PORT=
DB_USER=
DB_PASS=
DB_NAME=

3. Instale as dependências: npm install
4. Execute o projeto: npm run dev

Scripts

Este projeto utiliza npm como gerenciador de pacotes e inclui os seguintes scripts principais:

• npm run dev: Inicia o servidor de desenvolvimento.
• npm run start: Inicia o servidor de produção.
• npm run build: Constrói o projeto para produção.

Contribuindo

Se você deseja contribuir para este projeto, sinta-se à vontade para fazer fork do repositório, fazer suas alterações e abrir um pull request. Agradecemos todas as contribuições!

Licença

Este projeto está licenciado sob a Licença MIT - veja o arquivo LICENSE para mais detalhes.