nodetomic-api-swagger

Nodetomic-api-swagger

Simple and fast Restful API designed for horizontal scalability including cluster, based on Swagger, Nodejs, Redis + Passport, MongoDB, Express

Examples

http://localhost:8000

http://localhost:8000/api-docs/

Example horizontal scalability

Technologies

Requirements

• Nodejs >= 6.x.x (Recommended 8.x.x)
• MongoDB >= 3.x.x
• Redis >= 3.x.x

Installation

git clone https://github.com/kevoj/nodetomic-api-swagger
cd nodetomic-api-swagger
npm i

Development

Start

npm start

• http://localhost:8000

Build

npm run build

• Generate output folder: dist

  • dist
    • api-docs
    • client
    • server
    • cluster.config.js (pm2) (pm2 start cluster.config.js)
    • simple.config.js (pm2) (pm2 start simple.config.js)
    • package.json (npm start)

Test

npm test

You must be aware of running npm start

Lint

npm lint

Preview compiled in mode simple (pm2)

npm run pm2-dev-simple

• http://localhost:8000

Preview compiled in mode cluster (pm2)

npm run pm2-dev-cluster

• http://localhost:8000

Production

Run mode Default (node)

npm run serve

• http://localhost:8000

Run mode simple (pm2)

npm run pm2-simple

• http://localhost:8000

Run mode cluster (pm2)

npm run pm2-cluster

• http://localhost:8000

License

MIT © Leonardo Rico