readme.md

Orbit CLI

A command line tool for generating express api

Orbit generates the project skeleton which includes all the necessary code files, build script(Travis CI) and deployment script (docker).

Installation

npm install orbit-cli -g

Create Express API project

Open a command prompt and run:

orbit new project-name 

(or)

orbit-cli new project-name

Alternatively you can create project using below command

orbit n project-name 

(or)

orbit-cli n project-name

Create Express MVC project

Open a command prompt and run:

orbit mvc project-name 

(or)

orbit-cli mvc project-name

To get help

orbit help

(or)

orbit --help

Generate router file

The below command generate person.router.js file.

orbit route person

(or)

orbit r person

Generate middleware

The below command generate auth.middleware.js file.

orbit middleware auth

(or)

orbit mw auth

Generate mongoose model

The below command generate person.model.js file and installs mongoose dependency.

orbit model person

(or)

orbit m person

Generate controller

The below command generate person.ctrl.js file.

orbit ctrl person

(or)

orbit c person

Orbit CLI can generate multiple types of controllers:

Controller function

orbit ctrl person --function 

(or)

orbit c person -f

Controller class

orbit ctrl person --class 

(or)

orbit c person -c

Controller function (revealing module pattern)

orbit ctrl person --module 

(or)

orbit c person -m