vs4vijay / typescript-express-template

A Microservice Template in NodeJS, TypeScript, and Express

typescript-express-template

A Microservice Template in NodeJS, TypeScript, and Express

Express + Routing-Controllers + TypeScript + TypeORM + TypeDI

---

Installation

npm install

• Create .env file from .env.example and populate environment variables

---

Running

# Build and Run
npm start

# Run on local machine with watcher
npm run start:dev

---

Features

• TypeScript
• Depedency Injection of Services, Repositories, Controllers
• Modular App.ts
• Properly structured codebase models, repositories, services, controllers, migrations etc.
• ORM Migrations used for maintaining database schemas
• Follows pure REST APIs
• Input validations
• Use of .env file
• Git pre-commit hooks setup
• Linting and Standard Formatting
• Added system metadata like createdAt, updatedAt
• Use of DTOs
• Added audit log like createdBy, updatedBy
• isActive
• uuid as primary key
• Soft Delete Options
• Pagination
• Structured Logging
• Unit Testing
• Authentication
• Authorization
• Error Handling and Generic Error Middleware
• Search Framework
• AbstractService or interface Service
• Graceful Shutdown
• Containerized with Docker

---

Libraries Used

• NodeJS with TypeScript
  • ts-node and ts-node-dev for running on local machine
• Express Framework
• TypeORM - ORM Tool to interact with Database
• TypeDI - Dependency Injection library (https://github.com/typestack/typedi)
• routing-controllers - For Defining Routes in elegent way (https://github.com/typestack/routing-controllers)
• class-validator - For input validations (https://github.com/typestack/class-validator)
• class-transformer - For transforming objects (https://github.com/typestack/class-transformer)
• dotenv - Use Environment Variables from .env file
• ESLint - For Linting the ES and TypeScript codebase
  • ext install dbaeumer.vscode-eslint
• Prettier - For Formatting Standard (https://eslint.org/docs/user-guide/getting-started)
  • ext install esbenp.prettier-vscode
• Husky - https://github.com/typicode/husky
• lint-staged - https://github.com/okonet/lint-staged

---

Development

• Create an entity: npm run typeorm -- entity:create -n User
• Generate migration: npm run typeorm -- migration:generate -n CreateUser
• Run the migrations: npm run typeorm -- migration:run

Notes:

• Migration name pattern: AddTo
  • AddLastNameToUser
  • UpdateEmailToEmployee

---

Development Guidelines

• Make use of index.ts in folder which has multiple files

---

Development Notes

typescript-express-template's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• Update dependency @types/jest to v26.0.24
• Update dependency body-parser to v1.20.2
• Update dependency reflect-metadata to ^0.2.0
• Update dependency winston to v3.13.0
• Update Node.js to v20 (node, @types/node)
• Update dependency dotenv to v16
• Update dependency eslint to v9
• Update dependency eslint-config-prettier to v9
• Update dependency eslint-plugin-prettier to v5
• Update dependency helmet to v7
• Update dependency husky to v9
• Update dependency jest-junit to v16
• Update dependency lint-staged to v15
• Update dependency prettier to v3
• Update dependency rimraf to v5
• Update dependency ts-node-dev to v2
• Update dependency typescript to v5
• 🔐 Create all rate-limited PRs at once 🔐

Other Branches

These updates are pending. To force PRs open, click the checkbox below.

• Update dependency express to v4.19.2 [SECURITY]
• Update dependency sqlite3 to v5.1.5 [SECURITY]

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency class-validator to v0.14.0 [SECURITY]
• Update dependency typeorm to ^0.3.0 [SECURITY]
• Update dependency @types/cors to v2.8.17
• Update dependency @types/express to v4.17.21
• Update dependency ts-node-dev to v1.1.8
• Update Node.js to v14.21.3 (node, @types/node)
• Update dependency class-transformer to ^0.5.0
• Update dependency eslint to v7.32.0
• Update dependency eslint-plugin-prettier to v3.4.1
• Update dependency jest-junit to v12.3.0
• Update dependency prettier to v2.8.8
• Update dependency routing-controllers to ^0.10.0
• Update dependency typedi to ^0.10.0
• Update dependency typeorm-typedi-extensions to ^0.4.0
• Update dependency typescript to v4.9.5
• Update typescript-eslint monorepo to v4.33.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• Update dependency ts-node to v10
• Update jest monorepo to v29 (major) (@types/jest, jest)
• Update typescript-eslint monorepo to v7 (major) (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

dockerfile

Dockerfile

• node 14.16.1-alpine
• node 14.16.1-alpine

npm

package.json

• body-parser ^1.19.0
• class-transformer ^0.3.2
• class-validator 0.13.1
• cors ^2.8.5
• dotenv ^8.2.0
• express ^4.17.1
• helmet ^4.4.1
• morgan ^1.10.0
• reflect-metadata ^0.1.13
• routing-controllers ^0.8.1
• sqlite3 ^5.0.1
• typedi ^0.8.0
• typeorm ^0.2.28
• typeorm-typedi-extensions ^0.2.3
• winston ^3.3.3
• @types/cors 2.8.10
• @types/express 4.17.11
• @types/jest 26.0.22
• @types/node 14.14.43
• @typescript-eslint/eslint-plugin 4.22.0
• @typescript-eslint/parser 4.22.0
• eslint 7.24.0
• eslint-config-prettier 7.2.0
• eslint-plugin-prettier 3.3.1
• husky 6.0.0
• lint-staged 10.5.4
• prettier 2.2.1
• ts-node 9.1.1
• ts-node-dev 1.1.6
• typescript 4.1.5
• jest 26.6.3
• jest-junit 12.0.0
• rimraf 3.0.2

---

• Check this box to trigger a request for Renovate to run again on this repository