nodetomic-api-swagger

Nodetomic-api-swagger

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

Examples

http://localhost:8000/docs

Example horizontal scalability

Technologies

Requirements

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

Installation

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

Features

• Tokens

  • JWT merged with REDIS

• Redis

  • Pub/Sub Expired, del, etc by key

• Middleware

  • Login validation
  • Role validation

• Socket.io

  • cluster

• Authentication

  • local
  • facebook
  • twitter
  • google
  • github
  • bitbucket

• Session

  • Single or Multiple (One or more devices at the same time)
  • Get list of sessions
  • Destroy a session

• Scalability

  • Support for simple execution
  • Support for cluster

Structure

• client
• src
  • api
    • controllers
    • models
    • sockets
    • swagger
  • assets
  • auth
    • controllers
    • passports
    • swagger
    • services
  • config
  • core
  • lib
  • seeds
  • views
  • app.js

Development

Start

npm start

• http://localhost:8000

Build

npm run build

• Generate output folder: dist

  • dist
    • client
    • server
    • cluster.config.js
    • simple.config.js
    • package.json
      • npm start
      • npm run simple
      • npm run cluster

Test

npm test

Lint

npm lint

Node [Production]

Default

Description: Run node in a single thread

npm run serve

• http://localhost:8000

PM2 [Development]

Simple

Description: Run pm2 in a single thread and run the monitor

npm run dev-simple

• http://localhost:8000

Cluster

Description: Run pm2 in multiple threads and run the monitor

npm run dev-cluster

• http://localhost:8000

PM2 [Production]

Simple

Description: Run pm2 in a single thread

npm run simple

• http://localhost:8000

Cluster

Description: Run pm2 in multiple threads

npm run cluster

• http://localhost:8000

Destroy

PM2

Description: destroyed pm2 simple and pm2 cluster

npm stop

Node

Description: destroyed all process for node

killall node

License

MIT © Leonardo Rico