Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vs4vijay/typescript-express-template
A Microservice Template in NodeJS, TypeScript, and Express
https://github.com/vs4vijay/typescript-express-template
api boilerplate boilerplate-template express express-typescript-boilerplate http-api http-server microservice nodejs rest-api routing-controllers starterkit template typedi typeorm typescript
Last synced: 6 days ago
JSON representation
A Microservice Template in NodeJS, TypeScript, and Express
- Host: GitHub
- URL: https://github.com/vs4vijay/typescript-express-template
- Owner: vs4vijay
- License: mit
- Created: 2021-01-14T18:47:42.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-04T20:04:25.000Z (14 days ago)
- Last Synced: 2024-11-04T21:18:47.524Z (13 days ago)
- Topics: api, boilerplate, boilerplate-template, express, express-typescript-boilerplate, http-api, http-server, microservice, nodejs, rest-api, routing-controllers, starterkit, template, typedi, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 315 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 55
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typescript-express-template
A Microservice Template in NodeJS, TypeScript, and Express
Express + Routing-Controllers + TypeScript + TypeORM + TypeDI
---
## Installation
```shell
npm install
```
- Create `.env` file from `.env.example` and populate environment variables
---
## Running
```shell
# Build and Run
npm start
# Run on local machine with watcher
npm run start:dev
```
---
## Features
- [x] TypeScript
- [x] Depedency Injection of Services, Repositories, Controllers
- [x] Modular App.ts
- [x] Properly structured codebase models, repositories, services, controllers, migrations etc.
- [x] ORM Migrations used for maintaining database schemas
- [x] Follows pure REST APIs
- [x] Input validations
- [x] Use of `.env` file
- [x] Git pre-commit hooks setup
- [x] Linting and Standard Formatting
- [x] Added system metadata like createdAt, updatedAt
- [x] Use of DTOs
- [x] Added audit log like createdBy, updatedBy
- [x] isActive
- [x] uuid as primary key
- [x] Soft Delete Options
- [x] Pagination
- [ ] Structured Logging
- [ ] Unit Testing
- [ ] Authentication
- [ ] Authorization
- [ ] Error Handling and Generic Error Middleware
- [ ] Search Framework
- [ ] AbstractService or interface Service
- [ ] Graceful Shutdown
- [x] 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
```javascript
```