https://github.com/everton-dgn/boilerplate_express
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.
https://github.com/everton-dgn/boilerplate_express
backend clean-architecture clean-code commonjs eslint express husky jest lintstaged node pino-http prettier swagger swagger-ui swc tsx typescript vite
Last synced: 3 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/everton-dgn/boilerplate_express
- Owner: everton-dgn
- License: mit
- Created: 2023-09-27T15:18:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-14T03:29:58.000Z (over 2 years ago)
- Last Synced: 2026-01-03T14:23:32.413Z (6 months ago)
- Topics: backend, clean-architecture, clean-code, commonjs, eslint, express, husky, jest, lintstaged, node, pino-http, prettier, swagger, swagger-ui, swc, tsx, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 448 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Boilerplate Node + Express
# :memo: Sobre o Projeto
This application is a boilerplate for complex and large systems, especially those that need to scale with security and code quality.
---
# :pushpin: Indice
- [Tecnologias Utilizadas](#globe_with_meridians-tecnologias-utilizadas)
- [Pre Requisitos](#white_check_mark-pre-requisitos)
- [Como Utilizar](#question-como-utilizar)
- [Configuracao](#wrench-configuracao)
- [Execucao](#zap-execucao)
---
# :globe_with_meridians: 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
---
# :white_check_mark: Pre Requisitos
- node última versão lts.
- yarn última versão lts.
---
# :question: Como Utilizar
Clone o projeto e navegue até a pasta:
```bash
git clone https://github.com/everton-dgn/boilerplate_express.git
cd boilerplate_express
```
Instale as dependências:
```bash
yarn
```
---
# :wrench: Configuracao
Crie um arquivo .env na raiz do projeto e adicione as variáveis de ambiente:
```
APP_PORT=3000
```
---
# :zap: Execucao
Disponível em `http://localhost:3000`.
Desenvolvimento:
```bash
yarn dev
```
Produção:
```bash
yarn build
yarn start
```