typescript-boilerplate

 

🔥 Pronto para desenvolver! Esse template foi criado para servir como base para qualquer projeto NodeJS.

🏴󠁫󠁧󠁧󠁯󠁿 Todas as ferramentas básicas incluídas e configuradas:

• TypeScript 4.4
• O Básico de docker para dev
• Testes unitários e coverage com Jest
• Configurações iniciais do ESLint
• Prettier para formatação de código
• NPM scripts
• Configuração padrão de arquivo em .editorconfig
• Configuração para husky: pre commit e pre push

Getting Started 🤩

A recomendação é utilizar esse template na versão LTS do Node.js.

Iniciar usando como template

Para iniciar, clique neste link usar este template ou no botão verde mais acima. Coloque seu código-fonte no diretório src e seus testes no diretório tests.

Iniciar fazendo clone do projeto

Para clonar o projeto, siga as instruções:

git clone https://github.com/flavionobre11/typescript-boilerplate
cd typescript-boilerplate
docker-compose up # ou npm install

NPM scripts

• format - formata o código fonte em src e tests utilizando prettier
• lint - faz o processo de lint no código fonte
• prebuild - faz o processo de lint no código fonte e exclui arquivos de build anterior
• build - transpila typescript para ES6
• start - inicia a aplicação usando build criado
• env - carrega envs
• start:dev - inicia a aplicação em modo desenvolvimento
• test - inicia testes
• test:e2e - inicia testes end to end
• prepare - inicializa o husky para usar precommit e prepush
• precommit - roda o lint e o format
• prepush - roda o lint

Nota: todos os scripts de inicialização já carregam a dependência dotenv.