Skip to content

luanyata/node-boilerplate

Repository files navigation

GoStack

Boilerplate Node + Typescript + Jest +... +...+ ...


GitHub language count Made by Luan Yata License Stargazers

Tecnologias

  • node
  • express
  • typescript
  • cors
  • celebrate (Validação)
  • JsonWebToken
  • knex (Query language)
  • SQLite (Banco de dados)

Banco de Dados

O banco de dados é gerenciado pelo Knex. Toda alteraação na estrutura do banco deve se dar atraves de migration do Knex.

Criar migration

npx knex migration:make name_migration

Execultar migrations:

npx knex migrate:latest

Commit

Todos os commits seguem um padrão estabelecido atravez de um conjunto de ferramentas

  • CommitLint
  • Commitizen
  • Cz-emoji

Adicionar arquivos no commit

git add .

Realizar commit

git cz

Testes

Todos os testes deve ser armazenados no diretorio /src/tests. São utilizados para realizar os testes as ferramentas:

  • Jest
  • SuperTests

Executar testes

npm run test

Rodando a API

Após clonar o repositorio execute os comandos dentro da pasta do projeto:

Instalação das denpendências:

npm install

Iniciar o serviço em modo de desenvolvimento:

npm run dev

Build de Produção:

npm run prod

Licença

MIT