node-express-typescript

Welcome to my boilerplate for nodeJS, typescript and expressJS, using nestjs

• node-express-typescript
  • Infos
  • Commands
    • Installation
    • Running the app
    • Test
  • TODO

Infos

Version recommended and tested:

• Nodejs v12.13.1 LTS, we recomemend you use the nvm to control the nodejs version. See more infos in this link.
• NPM v6.13.2
• Typescript v3.7.4
• NestJS CLI v6.14.2

Commands

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

TODO

• Config
  • node-config
• Config with environment variables (partial)
• Test
  • jest
  • supertest
• Auditoria
  • TypeORM with Logger
• API Docs
  • Swagger
• Validation Data
  • class-validator
• Runtime
  • docker
  • docker-compose
• Response Error Handler
• Crud
• BD
  • E/R
    • TypeORM
    • Remove package pg =/ e coloca-lo como peer
  • Mongoose
• I18N
• Auth
  • Oauth2
  • keycloak
  • Autentication Code with PKCE
  • passport
  • passport-oauth2
• Monitoring
  • Prometheus
  • Grafana
• Log
  • ELK
  • winston
• Check Recipes Section
• Craete Example Structure
  • Crud
  • With Swagger Documentation In DTO
  • With Swagger Documentation In Route
  • Validation field
  • Layers
• Migrates
• Server Rendering
  • Next.js
• DTO de reposta de tela
• Azure CI
• Email

Todo Documentations:

• Config
• Config Env Var
• Package Script Commmands
• Docker & Docker Compose
• Validate Data
• Swagger
• Explain about each file in root folder
• Explain docker-compose
• Explain dockerfile
• Explain how to develop with this code
• Explain The Stack
• Explain healthcheck
  • Dockerfile
  • Config default
• Documentation Code
• Explain that we use TypeORM and not sequelize
  • Explain that you need to install database dependence, like, mysql
• Pagination engine