typescript-express-starter 10.2.1 → 11.0.0

package/lib/node-postgres/swagger.yaml

@@ -1,123 +0,0 @@
-tags:
-- name: users
-  description: users API
-
-paths:
-# [GET] users
-  /users:
-    get:
-      tags:
-      - users
-      summary: Find All Users
-      responses:
-        200:
-          description: 'OK'
-        500:
-          description: 'Server Error'
-
-# [POST] users
-    post:
-      tags:
-      - users
-      summary: Add User
-      parameters:
-      - name: body
-        in: body
-        description: user Data
-        required: true
-        schema:
-          $ref: '#/definitions/users'
-      responses:
-        201:
-          description: 'Created'
-        400:
-          description: 'Bad Request'
-        409:
-          description: 'Conflict'
-        500:
-          description: 'Server Error'
-
-# [GET] users/id
-  /users/{id}:
-    get:
-      tags:
-      - users
-      summary: Find User By Id
-      parameters:
-      - name: id
-        in: path
-        description: User Id
-        required: true
-        type: integer
-      responses:
-        200:
-          description: 'OK'
-        409:
-          description: 'Conflict'
-        500:
-          description: 'Server Error'
-
-# [PUT] users/id
-    put:
-      tags:
-      - users
-      summary: Update User By Id
-      parameters:
-      - name: id
-        in: path
-        description: user Id
-        required: true
-        type: integer
-      - name: body
-        in: body
-        description: user Data
-        required: true
-        schema:
-          $ref: '#/definitions/users'
-      responses:
-        200:
-          description: 'OK'
-        400:
-          description: 'Bad Request'
-        409:
-          description: 'Conflict'
-        500:
-          description: 'Server Error'
-
-# [DELETE] users/id
-    delete:
-      tags:
-      - users
-      summary: Delete User By Id
-      parameters:
-      - name: id
-        in: path
-        description: user Id
-        required: true
-        type: integer
-      responses:
-        200:
-          description: 'OK'
-        409:
-          description: 'Conflict'
-        500:
-          description: 'Server Error'
-
-# definitions
-definitions:
-  users:
-    type: object
-    required:
-        - email
-        - password
-    properties:
-      email:
-        type: string
-        description: user Email
-      password:
-        type: string
-        description: user Password
-
-schemes:
- - https
- - http

package/lib/node-postgres/tsconfig.json

@@ -1,39 +0,0 @@
-{
-  "compileOnSave": false,
-  "compilerOptions": {
-    "target": "es2017",
-    "lib": ["es2017", "esnext.asynciterable"],
-    "typeRoots": ["node_modules/@types"],
-    "allowSyntheticDefaultImports": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "forceConsistentCasingInFileNames": true,
-    "moduleResolution": "node",
-    "module": "commonjs",
-    "pretty": true,
-    "sourceMap": true,
-    "declaration": true,
-    "outDir": "dist",
-    "allowJs": true,
-    "noEmit": false,
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
-    "importHelpers": true,
-    "baseUrl": "src",
-    "paths": {
-      "@/*": ["*"],
-      "@config": ["config"],
-      "@controllers/*": ["controllers/*"],
-      "@database": ["database"],
-      "@dtos/*": ["dtos/*"],
-      "@exceptions/*": ["exceptions/*"],
-      "@interfaces/*": ["interfaces/*"],
-      "@middlewares/*": ["middlewares/*"],
-      "@routes/*": ["routes/*"],
-      "@services/*": ["services/*"],
-      "@utils/*": ["utils/*"]
-    }
-  },
-  "include": ["src/**/*.ts", "src/**/*.json", ".env"],
-  "exclude": ["node_modules", "src/http", "src/logs"]
-}

package/lib/prisma/.dockerignore

@@ -1,18 +0,0 @@
-# compiled output
-.vscode
-/node_modules
-
-# code formatter
-.eslintrc
-.eslintignore
-.editorconfig
-.huskyrc
-.lintstagedrc.json
-.prettierrc
-
-# test
-jest.config.js
-
-# docker
-Dockerfile
-docker-compose.yml

package/lib/prisma/.editorconfig

@@ -1,9 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true

package/lib/prisma/.env.development.local

@@ -1,16 +0,0 @@
-# PORT
-PORT = 3000
-
-# DATABASE
-DATABASE_URL= mysql://root:password@localhost:3306/dev
-
-# TOKEN
-SECRET_KEY = secretKey
-
-# LOG
-LOG_FORMAT = dev
-LOG_DIR = ../logs
-
-# CORS
-ORIGIN = *
-CREDENTIALS = true

package/lib/prisma/.env.production.local

@@ -1,16 +0,0 @@
-# PORT
-PORT = 3000
-
-# DATABASE
-DATABASE_URL= mysql://root:password@localhost:3306/dev
-
-# TOKEN
-SECRET_KEY = secretKey
-
-# LOG
-LOG_FORMAT = combined
-LOG_DIR = ../logs
-
-# CORS
-ORIGIN = your.domain.com
-CREDENTIALS = true

package/lib/prisma/.env.test.local

@@ -1,16 +0,0 @@
-# PORT
-PORT = 3000
-
-# DATABASE
-DATABASE_URL= mysql://root:password@localhost:3306/dev
-
-# TOKEN
-SECRET_KEY = secretKey
-
-# LOG
-LOG_FORMAT = dev
-LOG_DIR = ../logs
-
-# CORS
-ORIGIN = *
-CREDENTIALS = true

package/lib/prisma/.eslintignore

@@ -1 +0,0 @@
-/dist

package/lib/prisma/.eslintrc

@@ -1,18 +0,0 @@
-{
-  "parser": "@typescript-eslint/parser",
-  "extends": ["prettier", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
-  "parserOptions": {
-    "ecmaVersion": 2018,
-    "sourceType": "module"
-  },
-  "rules": {
-    "@typescript-eslint/explicit-member-accessibility": 0,
-    "@typescript-eslint/explicit-function-return-type": 0,
-    "@typescript-eslint/no-parameter-properties": 0,
-    "@typescript-eslint/interface-name-prefix": 0,
-    "@typescript-eslint/explicit-module-boundary-types": 0,
-    "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/ban-types": "off",
-    "@typescript-eslint/no-var-requires": "off"
-  }
-}

package/lib/prisma/.huskyrc

@@ -1,5 +0,0 @@
-{
-  "hooks": {
-    "pre-commit": "lint-staged"
-  }
-}

package/lib/prisma/.lintstagedrc.json

@@ -1,5 +0,0 @@
-{
-  "*.ts": [
-    "npm run lint"
-  ]
-}

package/lib/prisma/.prettierrc

@@ -1,8 +0,0 @@
-{
-    "printWidth": 150,
-    "tabWidth": 2,
-    "singleQuote": true,
-    "trailingComma": "all",
-    "semi": true,
-    "arrowParens": "avoid"
-}

package/lib/prisma/.vscode/launch.json

@@ -1,35 +0,0 @@
-{
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "type": "node-terminal",
-            "request": "launch",
-            "name": "Dev typescript-express-starter",
-            "command": "npm run dev"
-        },
-        {
-            "type": "node-terminal",
-            "request": "launch",
-            "name": "Start typescript-express-starter",
-            "command": "npm run start"
-        },
-        {
-            "type": "node-terminal",
-            "request": "launch",
-            "name": "Test typescript-express-starter",
-            "command": "npm run test"
-        },
-        {
-            "type": "node-terminal",
-            "request": "launch",
-            "name": "Lint typescript-express-starter",
-            "command": "npm run lint"
-        },
-        {
-            "type": "node-terminal",
-            "request": "launch",
-            "name": "Lint:Fix typescript-express-starter",
-            "command": "npm run lint:fix"
-        }
-    ]
-}

package/lib/prisma/.vscode/settings.json

@@ -1,6 +0,0 @@
-{
-  "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
-  },
-  "editor.formatOnSave": false
-}

package/lib/prisma/Dockerfile.dev

@@ -1,19 +0,0 @@
-# NodeJS Version 16
-FROM node:16.18-buster-slim
-
-# Copy Dir
-COPY . ./app
-
-# Work to Dir
-WORKDIR /app
-
-# Install Node Package
-RUN npm install --legacy-peer-deps
-
-# Set Env
-ENV NODE_ENV development
-
-EXPOSE 3000
-
-# Cmd script
-CMD ["npm", "run", "dev"]

package/lib/prisma/Dockerfile.prod

@@ -1,19 +0,0 @@
-# NodeJS Version 16
-FROM node:16.18-buster-slim
-
-# Copy Dir
-COPY . ./app
-
-# Work to Dir
-WORKDIR /app
-
-# Install Node Package
-RUN npm install --legacy-peer-deps
-
-# Set Env
-ENV NODE_ENV production
-
-EXPOSE 3000
-
-# Cmd script
-CMD ["npm", "run", "start"]

package/lib/prisma/Makefile

@@ -1,46 +0,0 @@
-# app name should be overridden.
-# ex) production-stage: make build APP_NAME=<APP_NAME>
-# ex) development-stage: make build-dev APP_NAME=<APP_NAME>
-
-SHELL := /bin/bash
-
-APP_NAME = typescript-express
-APP_NAME := $(APP_NAME)
-
-.PHONY: help start clean db test
-
-help:
-	@grep -E '^[1-9a-zA-Z_-]+:.*?## .*$$|(^#--)' $(MAKEFILE_LIST) \
-	| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m %-43s\033[0m %s\n", $$1, $$2}' \
-	| sed -e 's/\[32m #-- /[33m/'
-
-#-- Docker
-up: ## Up the container images
-	docker-compose up -d
-
-down: ## Down the container images
-	docker-compose down
-
-build: ## Build the container image - Production
-	docker build -t ${APP_NAME}\
-		-f Dockerfile.prod .
-
-build-dev: ## Build the container image - Development
-	docker build -t ${APP_NAME}\
-		-f Dockerfile.dev .
-
-run: ## Run the container image
-	docker run -d -it -p 3000:3000 ${APP_NAME}
-
-pause: ## Pause the containers
-	docker container rm -f ${APP_NAME}
-
-clean: ## Clean the images
-	docker rmi -f ${APP_NAME}
-
-remove: ## Remove the volumes
-	docker volume rm -f ${APP_NAME}
-
-#-- Database
-db: ## Start the local database MySQL
-	docker-compose up -d mysql

package/lib/prisma/docker-compose.yml

@@ -1,51 +0,0 @@
-version: "3.9"
-
-services:
-  proxy:
-    container_name: proxy
-    image: nginx:alpine
-    ports:
-      - "80:80"
-    volumes:
-      - ./nginx.conf:/etc/nginx/nginx.conf
-    restart: "unless-stopped"
-    networks:
-      - backend
-
-  server:
-    container_name: server
-    build:
-      context: ./
-      dockerfile: Dockerfile.dev
-    ports:
-      - "3000:3000"
-    environment:
-      DATABASE_URL: mysql://root:password@localhost:3306/dev
-    volumes:
-      - ./:/app
-      - /app/node_modules
-    restart: "unless-stopped"
-    networks:
-      - backend
-    links:
-      - mysql
-    depends_on:
-      - mysql
-
-  mysql:
-    container_name: mysql
-    image: mysql:5.7
-    environment:
-      DATABASE_URL: mysql://root:password@localhost:3306/dev
-    ports:
-      - "3306:3306"
-    networks:
-      - backend
-
-networks:
-  backend:
-    driver: bridge
-
-volumes:
-  data:
-    driver: local

package/lib/prisma/ecosystem.config.js

@@ -1,57 +0,0 @@
-/**
- * @description pm2 configuration file.
- * @example
- *  production mode :: pm2 start ecosystem.config.js --only prod
- *  development mode :: pm2 start ecosystem.config.js --only dev
- */
- module.exports = {
-  apps: [
-    {
-      name: 'prod', // pm2 start App name
-      script: 'dist/server.js',
-      exec_mode: 'cluster', // 'cluster' or 'fork'
-      instance_var: 'INSTANCE_ID', // instance variable
-      instances: 2, // pm2 instance count
-      autorestart: true, // auto restart if process crash
-      watch: false, // files change automatic restart
-      ignore_watch: ['node_modules', 'logs'], // ignore files change
-      max_memory_restart: '1G', // restart if process use more than 1G memory
-      merge_logs: true, // if true, stdout and stderr will be merged and sent to pm2 log
-      output: './logs/access.log', // pm2 log file
-      error: './logs/error.log', // pm2 error log file
-      env: { // environment variable
-        PORT: 3000,
-        NODE_ENV: 'production',
-      },
-    },
-    {
-      name: 'dev', // pm2 start App name
-      script: 'ts-node', // ts-node
-      args: '-r tsconfig-paths/register --transpile-only src/server.ts', // ts-node args
-      exec_mode: 'cluster', // 'cluster' or 'fork'
-      instance_var: 'INSTANCE_ID', // instance variable
-      instances: 2, // pm2 instance count
-      autorestart: true, // auto restart if process crash
-      watch: false, // files change automatic restart
-      ignore_watch: ['node_modules', 'logs'], // ignore files change
-      max_memory_restart: '1G', // restart if process use more than 1G memory
-      merge_logs: true, // if true, stdout and stderr will be merged and sent to pm2 log
-      output: './logs/access.log', // pm2 log file
-      error: './logs/error.log', // pm2 error log file
-      env: { // environment variable
-        PORT: 3000,
-        NODE_ENV: 'development',
-      },
-    },
-  ],
-  deploy: {
-    production: {
-      user: 'user',
-      host: '0.0.0.0',
-      ref: 'origin/master',
-      repo: 'git@github.com:repo.git',
-      path: 'dist/server.js',
-      'post-deploy': 'npm install && npm run build && pm2 reload ecosystem.config.js --only prod',
-    },
-  },
-};

package/lib/prisma/jest.config.js

@@ -1,12 +0,0 @@
-const { pathsToModuleNameMapper } = require('ts-jest');
-const { compilerOptions } = require('./tsconfig.json');
-
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  roots: ['<rootDir>/src'],
-  transform: {
-    '^.+\\.tsx?$': 'ts-jest',
-  },
-  moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, { prefix: '<rootDir>/src' }),
-};

package/lib/prisma/nginx.conf

@@ -1,40 +0,0 @@
-user  nginx;
-worker_processes  1;
-
-error_log  /var/log/nginx/error.log warn;
-pid        /var/run/nginx.pid;
-
-events {
-    worker_connections  1024;
-}
-
-http {
-    include       /etc/nginx/mime.types;
-    default_type  application/octet-stream;
-
-    upstream api-server {
-        server server:3000;
-        keepalive 100;
-    }
-
-    server {
-        listen 80;
-        server_name localhost;
-
-        location / {
-		proxy_http_version 1.1;
-            	proxy_pass         http://api-server;
-        }
-
-    }
-
-    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
-                      '$status $body_bytes_sent "$http_referer" '
-                      '"$http_user_agent" "$http_x_forwarded_for"';
-
-    access_log  /var/log/nginx/access.log  main;
-
-    sendfile        on;
-    keepalive_timeout  65;
-    include /etc/nginx/conf.d/*.conf;
-}

package/lib/prisma/nodemon.json

@@ -1,12 +0,0 @@
-{
-    "watch": [
-        "src",
-        ".env"
-    ],
-    "ext": "js,ts,json",
-    "ignore": [
-        "src/logs/*",
-        "src/**/*.{spec,test}.ts"
-    ],
-    "exec": "ts-node -r tsconfig-paths/register --transpile-only src/server.ts"
-}

package/lib/prisma/package.json

@@ -1,84 +0,0 @@
-{
-  "name": "typescript-express-starter",
-  "version": "0.0.0",
-  "description": "TypeScript + Prisma + MySQL + Express API Server",
-  "author": "",
-  "license": "ISC",
-  "scripts": {
-    "start": "npm run build && cross-env NODE_ENV=production node dist/server.js",
-    "dev": "cross-env NODE_ENV=development nodemon",
-    "build": "swc src -d dist --source-maps --copy-files",
-    "build:tsc": "tsc && tsc-alias",
-    "test": "jest --forceExit --detectOpenHandles",
-    "lint": "eslint --ignore-path .gitignore --ext .ts src/",
-    "lint:fix": "npm run lint -- --fix",
-    "prisma:init": "prisma init",
-    "prisma:migrate": "prisma migrate dev --preview-feature",
-    "prisma:generate": "prisma generate",
-    "deploy:prod": "npm run build && pm2 start ecosystem.config.js --only prod",
-    "deploy:dev": "pm2 start ecosystem.config.js --only dev"
-  },
-  "prisma": {
-    "schema": "src/prisma/schema.prisma"
-  },
-  "dependencies": {
-    "@prisma/client": "^4.1.0",
-    "bcrypt": "^5.0.1",
-    "class-transformer": "^0.5.1",
-    "class-validator": "^0.13.2",
-    "compression": "^1.7.4",
-    "cookie-parser": "^1.4.6",
-    "cors": "^2.8.5",
-    "dotenv": "^16.0.1",
-    "envalid": "^7.3.1",
-    "express": "^4.18.1",
-    "helmet": "^5.1.1",
-    "hpp": "^0.2.3",
-    "jsonwebtoken": "^8.5.1",
-    "morgan": "^1.10.0",
-    "reflect-metadata": "^0.1.13",
-    "swagger-jsdoc": "^6.2.1",
-    "swagger-ui-express": "^4.5.0",
-    "typedi": "^0.10.0",
-    "winston": "^3.8.1",
-    "winston-daily-rotate-file": "^4.7.1"
-  },
-  "devDependencies": {
-    "@swc/cli": "^0.1.57",
-    "@swc/core": "^1.2.220",
-    "@types/bcrypt": "^5.0.0",
-    "@types/compression": "^1.7.2",
-    "@types/cookie-parser": "^1.4.3",
-    "@types/cors": "^2.8.12",
-    "@types/express": "^4.17.13",
-    "@types/hpp": "^0.2.2",
-    "@types/jest": "^28.1.6",
-    "@types/jsonwebtoken": "^8.5.8",
-    "@types/morgan": "^1.9.3",
-    "@types/node": "^17.0.45",
-    "@types/supertest": "^2.0.12",
-    "@types/swagger-jsdoc": "^6.0.1",
-    "@types/swagger-ui-express": "^4.1.3",
-    "@typescript-eslint/eslint-plugin": "^5.29.0",
-    "@typescript-eslint/parser": "^5.29.0",
-    "cross-env": "^7.0.3",
-    "eslint": "^8.20.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "husky": "^8.0.1",
-    "jest": "^28.1.1",
-    "lint-staged": "^13.0.3",
-    "node-config": "^0.0.2",
-    "node-gyp": "^9.1.0",
-    "nodemon": "^2.0.19",
-    "pm2": "^5.2.0",
-    "prettier": "^2.7.1",
-    "prisma": "^4.1.0",
-    "supertest": "^6.2.4",
-    "ts-jest": "^28.0.7",
-    "ts-node": "^10.9.1",
-    "tsc-alias": "^1.7.0",
-    "tsconfig-paths": "^4.0.0",
-    "typescript": "^4.7.4"
-  }
-}