npm

Share private packages across your team with npm Orgs, now with simplified billing via the aws marketplace!Learn more »

nodetomic-api

2.0.1 • Public • Published

Nodetomic Api

Codacy Badge NPM version Build Status dependencies Status devDependencies Status Gitter chat GitHub license Downloads

RESTful API Nodejs designed for horizontal scalability with support for cluster, based on Express, MongoDB, Redis, JWT, Socket.io, Passport.

If you want, the swagger version is also available: nodetomic-api-swagger

Technologies

Horizontal scalability

View horizontal scaling representation image with nodetomic-api HERE!

Structure

 
/src/
|-- api
|   |-- controllers
|   |-- models
|   |-- sockets
|   `-- routers
|-- assets
|-- auth
|   |-- controllers
|   |-- passports
|   |-- services
|   `-- routers
|-- config
|-- lib
|   |-- express
|   |-- mongoose
|   |-- redis-jwt
|   `-- socket.io
|-- views
`-- app.js

Preview

Development

Imgur

Production

Imgur

Requirements

Installation

Npm

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

Yarn

yarn add nodetomic-api --ignore-engines

Development

Start

Command: npm start

Description: Start the project in development mode

Imgur

Note: if you want work with nodemon execute the command npm run modemon

Build

Command: npm run build

Description: Compile the project by outputting the dist folder

Imgur

Note: Generate folder dist. So "dist/client" is optional. You can paste the compilation of a client here, for example of Vue, React, Angular...

Imgur

Test

Command: npm test

Description: Run Lint and run Build in production mode and execute the authentication methods and basic requests.

Imgur

Lint

Command: npm run lint

Description: Run ESLint to verify the entire project code


Pm2 [Development]

Dev-Simple

Command: npm run dev-simple

Description: Run Pm2 and compile the project in development mode in a single instance

Imgur

Dev-Cluster

Command: npm run dev-cluster

Description: Run Pm2 and compile the project in development mode in multiple instances

Imgur

Pm2 [Production]

Simple

Command: npm run simple

Description: Run Pm2 and compile the project in production mode in a single instance

Imgur

Cluster

Command: npm run cluster

Description: Run Pm2 and compile the project in production mode in multiple instances

Imgur

Stop

Pm2

Command: npm stop

Description: Stops all processes associated with project pm2

Node

Command: killall node

Description: Destroyed all process for node

API Docs

You can find the documentation HERE!

License

MIT © Leonardo Rico

install

npm i nodetomic-api

Downloadsweekly downloads

2

version

2.0.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability