code standarts for nestjs

Author: lachesse

nestjs/.env

@@ -0,0 +1,9 @@
+NODE_ENV=production
+
+PORT=3000
+
+POSTGRES_HOST=postgres
+POSTGRES_PORT=5432
+POSTGRES_USER=nestjsexample
+POSTGRES_PASSWORD=mypass
+POSTGRES_DB=nestjs

nestjs/.eslintrc.js

@@ -0,0 +1,42 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js', '**/migrations/*.ts'],
+  rules: {
+    '@typescript-eslint/typedef': [
+      'error',
+      {
+        arrowParameter: true,
+      },
+    ],
+    '@typescript-eslint/explicit-module-boundary-types': ['error'],
+    '@typescript-eslint/no-explicit-any': ['error'],
+    '@typescript-eslint/adjacent-overload-signatures': ['error'],
+    '@typescript-eslint/explicit-function-return-type': ['error'],
+    'no-console': ['warn'],
+    '@typescript-eslint/explicit-member-accessibility': ['error'],
+    '@typescript-eslint/no-duplicate-imports': ['error'],
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': ['error'],
+    '@typescript-eslint/no-require-imports': ['error'],
+    '@typescript-eslint/no-unnecessary-type-arguments': ['error'],
+    '@typescript-eslint/non-nullable-type-assertion-style': ['error'],
+    '@typescript-eslint/prefer-readonly': ['error'],
+    '@typescript-eslint/no-unnecessary-type-constraint': ['error'],
+    '@typescript-eslint/no-array-constructor': ['error'],
+    '@typescript-eslint/no-invalid-void-type': ['error'],
+  },
+};

nestjs/.gitignore

@@ -0,0 +1,34 @@
+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json

nestjs/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

nestjs/README.md

@@ -0,0 +1,43 @@
+# Code standarts for NestJS application
+
+At the start a new project follow the next steps:
+
+## Configure ESLint and Prettier
+
+1. Run **npm install prettier eslint-plugin-prettier eslint-config-prettier eslint --save-dev**
+2. Copy [.prettierrc.json](.prettierrc.json) file to your project to root folder
+3. Copy [.eslintrc.json](.eslintrc.json) file to your project to root folder
+4. Add script - **"lint": "eslint \"{src,apps,libs,test}/\**/*.ts\" --fix"** to [.package.json](.package.json)
+
+## Configure husky pre-commit
+
+1. Run **npm install husky --save-dev**
+2. Add script - **"prepare": "husky install"** to [.package.json](.package.json)
+3. Run **npm run prepare** after that will be created .husky folder in root project
+4. Run **npx husky add .husky/pre-commit "npm lint"** after that will be created file pre-commit in .husky folder.
+In this file you can add any scripts what you want
+
+## Configure environment
+
+1. Run **npm i --save @nestjs/config**
+2. Add ConfigModule to [./src/app.module.ts](./src/app.module.ts) like in the example
+3. Copy [.env](.env) file to your project to root folder and change the secret data to yours
+
+## Configure swagger
+
+1. Run **npm install --save @nestjs/swagger**
+2. Сopy the swagger section from the [./src/main.ts](./src/main.ts) file
+3. Change the title, description and tag to your own
+
+## Configure database
+
+1. Run **npm install --save @nestjs/typeorm typeorm postgres pg**
+1. Copy the entire contents of the folder [./src/database/](./src/database/)
+2. Add TypeOrmModule to [./src/app.module.ts](./src/app.module.ts) like in the example
+
+## Configure docker
+
+1. Copy [.docker-compose.yaml.json](.docker-compose.yaml.json) file to your project to root folder
+2. Copy the entire contents of the folder [./docker/](./docker/)
+3. Copy [.init.sh](.init.sh) file to your project to root folder
+4. Start docker with command **COMPOSE_HTTP_TIMEOUT=300 docker-compose --env-file=.env -f docker-compose.yaml up -d --build**

nestjs/docker-compose.yaml

@@ -0,0 +1,28 @@
+version: '3.8'
+
+services:
+  postgres:
+    image: postgres:latest
+    ports:
+      - ${POSTGRES_PORT}:${POSTGRES_PORT}
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+      - ./init.sh:/docker-entrypoint-initdb.d/init.sh
+    environment:
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+      POSTGRES_USER: ${POSTGRES_USER}
+      POSTGRES_DB: ${POSTGRES_DB}
+    restart: on-failure
+
+  backend:
+    build:
+      context: .
+      dockerfile: ./docker/dockerfile
+    depends_on: 
+      - postgres
+    ports:
+      - ${PORT}:${PORT}
+    restart: on-failure
+    
+volumes:
+  pgdata:

nestjs/docker/dockerfile

@@ -0,0 +1,7 @@
+FROM node:16.9.1-alpine3.14
+WORKDIR /base
+COPY package.json .
+RUN npm install 
+COPY . .
+EXPOSE 3000
+CMD [ "sh", "-c", "npm run typeorm:run && npm run start:debug" ]

nestjs/init.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+set -e
+
+psql -v ON_ERROR_STOP=1 --username "postgres" --dbname "postgres" <<-EOSQL
+    CREATE DATABASE nestjs;
+    USE nestjs;
+    create user nestjsexample with encrypted password 'mypass';
+    grant all on database nestjs to nestjsexample;
+EOSQL

nestjs/nest-cli.json

@@ -0,0 +1,4 @@
+{
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src"
+}