NestJS starter
NestJS framework starter repository.
Technologies
-
Language
- Docs
- TypeScript: https://www.typescriptlang.org/docs/
- Packages
- typescript: https://github.com/microsoft/TypeScript
- Docs
-
Web Application Framework
- Docs
- NestJS: https://docs.nestjs.com/
- Packages
- @nestjs: https://github.com/nestjs/nest
- Docs
-
Database Access
- Docs
- TypeORM: https://typeorm.io/
- Supports MySQL / Postgres / SQLite And more...
- Automatic migrations generation
- TypeORM: https://typeorm.io/
- Packages
- @nestjs/typeorm: https://github.com/nestjs/typeorm
- typeorm: https://github.com/typeorm/typeorm
- Docs
-
GraphQL
- Docs
- GraphQL: https://graphql.org/learn/
- Apollo: https://www.apollographql.com/docs/
- TypeGraphQL: https://typegraphql.ml/
- Packages
- @nestjs/graphql: https://github.com/nestjs/graphql
- apollo-server-express: https://github.com/apollographql/apollo-server/tree/master/packages/apollo-server-express
- graphql-tools: https://github.com/apollographql/graphql-tools
- graphql: https://github.com/graphql/graphql-js
- type-graphql: https://github.com/19majkel94/type-graphql
- Docs
-
Validation
- class-validator: https://github.com/typestack/class-validator
-
Serialization
- class-transformer: https://github.com/typestack/class-transformer
-
Security
- helmet: https://github.com/helmetjs/helmet
- bcrypt: https://github.com/kelektiv/node.bcrypt.js
- CORS: NestJS built-in
-
Authentication
- Docs
- JWT: https://jwt.io/
- JWT Node.js: https://github.com/auth0/node-jsonwebtoken
- Passport: http://www.passportjs.org/
- Packages
- @nestjs/passport: https://github.com/nestjs/passport
- passport: https://github.com/jaredhanson/passport
- @nestjs/jwt: https://github.com/nestjs/jwt
- passport-jwt: https://github.com/mikenicholson/passport-jwt
- Docs
-
Health Check
- @nestjs/terminus: https://github.com/nestjs/terminus
- @godaddy/terminus: https://github.com/godaddy/terminus
-
12-Factor based config
src/config/config.service.tssrc/config/config.env.ts
-
Linter
- Docs
- ESLint: https://eslint.org/
- Packages
- eslint: https://github.com/eslint/eslint
- eslint-config-airbnb: https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb
- @typescript-eslint/parser: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/parser
- @typescript-eslint/eslint-plugin: https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin
- Docs
-
Formatter
- Docs
- Prettier: https://prettier.io/
- Packages
- prettier: https://github.com/prettier/prettier
- eslint-config-prettier: https://github.com/prettier/eslint-config-prettier
- Docs
-
Test
- Docs
- Jest: https://jestjs.io/
- Packages
- Docs
-
Documentation
- Docs
- Compodoc: https://compodoc.app/
- Packages
- @compodoc/compodoc: https://github.com/compodoc/compodoc
- Docs
-
Documentation OpenAPI
- Docs
- OpenAPI: https://www.openapis.org/
- Swagger UI: https://swagger.io/tools/swagger-ui/
- Packages
- @nestjs/swagger: https://github.com/nestjs/swagger
- swagger-ui-express: https://github.com/scottie1984/swagger-ui-express
- Docs
Installation
yarn global add @nestjs/cli
yarn installRunning the app
# development
yarn run start
# watch mode
yarn run start:dev
# production mode
yarn run start:prodTest
# unit tests
yarn run test
# e2e tests
yarn run test:e2e
# test coverage
yarn run test:covDB migration
# generate
yarn run migration:generate <name>
# show all migrations
yarn run migration:show
# run
yarn run migration:run
# dry run
yarn run schema:log
# revert
yarn run migration:revertDocumentation
yarn run docHow would I set this up myself
# creating a new project
yarn global add @nestjs/cli
nest new nestjs-starter
cd nestjs-starter
# database access
yarn add @nestjs/typeorm typeorm
yarn add sqlite3 pg
yarn add pluralize
yarn add -D @types/pluralize
# graphql
yarn add @nestjs/graphql apollo-server-express graphql-tools graphql
yarn add type-graphql
# validation
yarn add class-validator
# serialization
yarn add class-transformer
# security
yarn add helmet
yarn add bcrypt
yarn add -D @types/bcrypt
# auth
yarn add @nestjs/passport passport
yarn add @nestjs/jwt passport-jwt
yarn add -D @types/passport-jwt
yarn add passport-mock-strategy
# performance
yarn add compression
# health check
yarn add @nestjs/terminus @godaddy/terminus
# linter
yarn add -D eslint
yarn add -D eslint-plugin-import
yarn add -D eslint-plugin-react eslint-plugin-react-hooks
yarn add -D eslint-plugin-jsx-a11y
yarn add -D eslint-config-airbnb
yarn add -D @typescript-eslint/parser @typescript-eslint/eslint-plugin
# formatter
yarn add -D eslint-config-prettier
# documentation
yarn add -D @compodoc/compodoc
# documentation openapi
yarn add @nestjs/swagger swagger-ui-express