nodetomic-api-swagger
v3.4.7
RESTful API Nodejs designed for horizontal scalability with support for cluster, based on Swagger, Redis, JWT, Passport, Socket.io, Express, MongoDB.
RESTfulrest-swaggerapi-swaggerapi-rest-swaggerrest-apiapi-authswaggerswagger-clusterswagger-socketswagger-api
0/weekUpdated 3 years agoMITUnpacked: 19.7 MB
Published by Leonardo Rico Guevara - https://github.com/kevoj
npm install nodetomic-api-swagger
Nodetomic Api Swagger
       
> RESTful API Nodejs designed for horizontal scalability with support for cluster, based on Swagger, Redis, JWT, Passport, Socket.io, Express, MongoDB.
$3
$3
url:
$3
url:
OpenAPI Spec compatibility: 2.0, 3.0
$3
View horizontal scaling representation image with nodetomic-api-swagger HERE!
$3
/src/
|-- api
| |-- swagger
| |-- controllers
| |-- models
|-- sockets-- services
|-- assets
|-- auth
| |-- swagger
| |-- controllers
| |-- passports
|
|-- config
|-- lib
| |-- express
| |-- mongoose
| |-- redis-jwt
| |-- socket.io
|-- swagger-- app.js
|-- views
Requirements
- Nodejs >= 6.x.x (Recommended last version)
- MongoDB >= 3.x.x
- Redis >= 3.x.x (Recommended last version)
Installation
Npm
``bash`
git clone https://github.com/kevoj/nodetomic-api-swagger
cd nodetomic-api-swagger
npm i
Yarn
`bash`
yarn add nodetomic-api-swagger --ignore-engines
Development
$3
Command: npm start
Description: Start the project in development mode
Note: if you want work with nodemon execute the command npm run modemon
$3
Command: npm run build
Description: Compile the project by outputting the dist folder
Note: Generate folder dist. So "dist/client" is optional. You can paste the compilation of a client here, for example of Vue, React, Angular...
$3
Command: npm test
Description: Run Lint and run Build in production mode and execute the authentication methods and basic requests.
$3
Command: npm run lint
Description: Run ESLint to verify the entire project code
Pm2 [Development]
$3
Command: npm run dev-simple
Description: Run Pm2 and compile the project in development mode in a single instance
$3
Command: npm run dev-cluster
Description: Run Pm2 and compile the project in development mode in multiple instances
Pm2 [Production]
$3
Command: npm run simple
Description: Run Pm2 and compile the project in production mode in a single instance
$3
Command: npm run cluster
Description: Run Pm2 and compile the project in production mode in multiple instances
Stop
$3
Command: npm stop
Description: Stops all processes associated with project pm2
$3
Command: killall node`
Description: Destroyed all process for node
API Docs
You can find the documentation HERE!
License
MIT © Leonardo Rico