https://github.com/everton-dgn/boilerplate_fastify
This boilerplate project provides a solid starting point for building scalable and maintainable APIs using Node.js and Fastify. It adheres to best practices, includes linting with ESLint, and comes pre-configured with a testing suite.
https://github.com/everton-dgn/boilerplate_fastify
backend clean-architecture clean-code eslint esmodules fastify husky javascript jest lintstaged node prettier supertest swagger swagger-ui typescript
Last synced: 7 months ago
JSON representation
This boilerplate project provides a solid starting point for building scalable and maintainable APIs using Node.js and Fastify. 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_fastify
- Owner: everton-dgn
- License: mit
- Created: 2023-09-24T01:50:05.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-14T03:28:52.000Z (almost 2 years ago)
- Last Synced: 2023-10-15T16:50:45.183Z (almost 2 years ago)
- Topics: backend, clean-architecture, clean-code, eslint, esmodules, fastify, husky, javascript, jest, lintstaged, node, prettier, supertest, swagger, swagger-ui, typescript
- Language: TypeScript
- Homepage:
- Size: 474 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Boilerplate Node + Fastify
# :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
- Fastify
- Jest
- Supertest
- Lints: Husky, ESlint, Stylelint, Commitlint, Lint-Staged e Prettier
- Swagger and Swagger UI
---
# :white_check_mark: Pre Requisitos
- node última versão lts.
- yarn.
---
# :question: Como Utilizar
Clone o projeto e navegue até a pasta:
```bash
git clone https://github.com/everton-dgn/boilerplate_fastify.git
cd boilerplate_fastify
```
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=5000
```
---
# :zap: Execucao
Disponível em `http://localhost:5000`.
Desenvolvimento:
```bash
yarn dev
```
Produção:
```bash
yarn build
yarn start
```