{"id":19723960,"url":"https://github.com/vs4vijay/typescript-express-template","last_synced_at":"2025-04-29T22:31:11.101Z","repository":{"id":37028159,"uuid":"329705544","full_name":"vs4vijay/typescript-express-template","owner":"vs4vijay","description":"A Microservice Template in NodeJS, TypeScript, and Express","archived":false,"fork":false,"pushed_at":"2025-04-29T00:15:57.000Z","size":557,"stargazers_count":6,"open_issues_count":57,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-29T01:29:50.033Z","etag":null,"topics":["api","boilerplate","boilerplate-template","express","express-typescript-boilerplate","http-api","http-server","microservice","nodejs","rest-api","routing-controllers","starterkit","template","typedi","typeorm","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vs4vijay.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-01-14T18:47:42.000Z","updated_at":"2025-01-14T09:39:33.000Z","dependencies_parsed_at":"2023-02-05T16:01:05.916Z","dependency_job_id":"cf5615b9-4d69-4b60-8fa6-872a5b0a2ebe","html_url":"https://github.com/vs4vijay/typescript-express-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vs4vijay%2Ftypescript-express-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vs4vijay%2Ftypescript-express-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vs4vijay%2Ftypescript-express-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vs4vijay%2Ftypescript-express-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vs4vijay","download_url":"https://codeload.github.com/vs4vijay/typescript-express-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251593005,"owners_count":21614455,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","boilerplate","boilerplate-template","express","express-typescript-boilerplate","http-api","http-server","microservice","nodejs","rest-api","routing-controllers","starterkit","template","typedi","typeorm","typescript"],"created_at":"2024-11-11T23:24:04.433Z","updated_at":"2025-04-29T22:31:10.607Z","avatar_url":"https://github.com/vs4vijay.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# typescript-express-template\n\nA Microservice Template in NodeJS, TypeScript, and Express\n\nExpress + Routing-Controllers + TypeScript + TypeORM + TypeDI\n\n---\n\n## Installation\n\n```shell\nnpm install\n```\n\n- Create `.env` file from `.env.example` and populate environment variables\n\n---\n\n## Running\n\n```shell\n# Build and Run\nnpm start\n\n# Run on local machine with watcher\nnpm run start:dev\n```\n\n---\n\n## Features\n\n- [x] TypeScript\n- [x] Depedency Injection of Services, Repositories, Controllers\n- [x] Modular App.ts\n- [x] Properly structured codebase models, repositories, services, controllers, migrations etc.\n- [x] ORM Migrations used for maintaining database schemas\n- [x] Follows pure REST APIs\n- [x] Input validations\n- [x] Use of `.env` file\n- [x] Git pre-commit hooks setup\n- [x] Linting and Standard Formatting\n- [x] Added system metadata like createdAt, updatedAt\n- [x] Use of DTOs\n- [x] Added audit log like createdBy, updatedBy\n- [x] isActive\n- [x] uuid as primary key\n- [x] Soft Delete Options\n- [x] Pagination\n- [ ] Structured Logging\n- [ ] Unit Testing\n- [ ] Authentication\n- [ ] Authorization\n- [ ] Error Handling and Generic Error Middleware\n- [ ] Search Framework\n- [ ] AbstractService or interface Service\n- [ ] Graceful Shutdown\n- [x] Containerized with Docker\n\n---\n\n## Libraries Used\n\n- NodeJS with TypeScript\n  - ts-node and ts-node-dev for running on local machine\n- Express Framework\n- TypeORM - ORM Tool to interact with Database\n- TypeDI - Dependency Injection library (https://github.com/typestack/typedi)\n- routing-controllers - For Defining Routes in elegent way (https://github.com/typestack/routing-controllers)\n- class-validator - For input validations (https://github.com/typestack/class-validator)\n- class-transformer - For transforming objects (https://github.com/typestack/class-transformer)\n- dotenv - Use Environment Variables from .env file\n- ESLint - For Linting the ES and TypeScript codebase\n  - `ext install dbaeumer.vscode-eslint`\n- Prettier - For Formatting Standard (https://eslint.org/docs/user-guide/getting-started)\n  - `ext install esbenp.prettier-vscode`\n- Husky - https://github.com/typicode/husky\n- lint-staged - https://github.com/okonet/lint-staged\n\n---\n\n## Development\n\n- Create an entity: `npm run typeorm -- entity:create -n User`\n- Generate migration: `npm run typeorm -- migration:generate -n CreateUser`\n- Run the migrations: `npm run typeorm -- migration:run`\n\nNotes:\n\n- Migration name pattern: Add\u003cfield\u003eTo\u003cEntity\u003e\n  - AddLastNameToUser\n  - UpdateEmailToEmployee\n\n---\n\n### Development Guidelines\n\n- Make use of `index.ts` in folder which has multiple files\n\n---\n\n### Development Notes\n\n```javascript\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvs4vijay%2Ftypescript-express-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvs4vijay%2Ftypescript-express-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvs4vijay%2Ftypescript-express-template/lists"}