README.md

Statements	Branches	Functions	Lines

Skeleton API

Production ready Rest API using Node.js with Typescript

$ npm run start

API Documentation

You can open swagger-based API Documentation on http://<your host>:<port>/api-docs.

Project structure

/ <root>
- coverage/
    - <some coverage file results>
- dist/ <production ready script>
    - config/
    - middleware/
    - services/
    - utils/
    - router.js
    - server.js
- src/ <development source code>
    - config/
    - middleware/
    - services/
    - utils/
    - router.ts
    - server.ts
- .env
- .gitignore
- package.json
- package-lock.json
- pm2.yaml
- README.md
- tsconfig.json

Technology stacks

• Typescript with a strict mode
• Express, latest version with async/await supports
• Jest & Supertest make sure your code was right
• PM2 to manage (process) cluster of your node application
• Swagger-UI make easy to read API Documentation

Thanks to

Alex Permyakov for his blog