Node Typescript Boilerplate for Microservices. Skeleton for Node.js Apps written in TypeScript (with Setup Instructions for ESLint, Prettier, and Husky)
APACHE-2.0 License
Our main purpose with this Skeleton is to start server application with node js and typescript.
Try it!! I am happy to hear your feedback or any kind of new features.
Quick start
Contiuous Integration
Documentation Standards
Test Coverage Maintenance
Production Ready Setup
express
, @types/express
@types/node
typescript
dotenv
cors
helmet
http-status-codes
winston
git clone https://github.com/santoshshinde2012/node-boilerplate.git
npm install
npm run dev
npm install
npm run build
npm run start
.env
values for your refrence just check .env.example
Name | Description |
---|---|
wiki/ | You can add project documentation and insructions file here |
src/ | Source files |
src/abstractions | Abstarct classes and Interfaces |
src/components | REST API Components & Controllers |
src/lib | Reusable utilises and library source code like a logger |
src/middleware/ | Express Middlewares like error handler feature |
build/ | Compiled source files will be placed here |
tests/ | Test cases will be placed here |
tests/helpers/ | Helpers for test cases will be placed here |
tests/unit-tests/ | Unit Test cases will be placed here |
tests/integration-tests/ | API routes (Integration) Test cases will be placed here |
Set the APPLY_ENCRYPTION
environment variable to true
to enable encryption.
The swagger documentation is available at the following url ${host}/docs
:
${host}/api/system/info
- Return the system information in response${host}/system/time
- Return the current time in response${host}/system/usage
- Return the process and system memory usage in response${host}/system/process
- Return the process details in response${host}/system/error
- Return the error generated object in responsechmod ug+x .husky/*
chmod ug+x .git/hooks/*