Skip to content

This boilerplate project provides a solid starting point for building scalable and maintainable APIs using Node.js and Express. It adheres to best practices, includes linting with ESLint, and comes pre-configured with a testing suite.

License

Notifications You must be signed in to change notification settings

everton-dgn/boilerplate_express

Repository files navigation

Boilerplate Node + Express

📝 Sobre o Projeto

This application is a boilerplate for complex and large systems, especially those that need to scale with security and code quality.


📌 Indice



🌐 Tecnologias Utilizadas

  • Node.js
  • TypeScript
  • Express
  • Vitest
  • Supertest
  • Lints: Husky, ESlint, Stylelint, Commitlint, Lint-Staged e Prettier
  • Swagger and Swagger UI Express
  • Pino and Pino-http
  • Dotenv
  • Compression


✅ Pre Requisitos

  • node última versão lts.
  • yarn última versão lts.


❓ Como Utilizar

Clone o projeto e navegue até a pasta:

git clone https://github.com/everton-dgn/boilerplate_express.git
cd boilerplate_express

Instale as dependências:

yarn


🔧 Configuracao

Crie um arquivo .env na raiz do projeto e adicione as variáveis de ambiente:

APP_PORT=3000


⚡ Execucao

Disponível em http://localhost:3000.

Desenvolvimento:

yarn dev

Produção:

yarn build
yarn start

About

This boilerplate project provides a solid starting point for building scalable and maintainable APIs using Node.js and Express. It adheres to best practices, includes linting with ESLint, and comes pre-configured with a testing suite.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published