Skip to content
/ api-cli Public

A CLI Tool which writes all the boiler plate code and installs all the basic Dependencies(Express,body-parser etc) which helps to setup Fast REST APIs.

Notifications You must be signed in to change notification settings

prkhrv/api-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

api-cli 💻

GitHub release

A CLI tool Which writes all the boiler-plate API and install Dependencies Express body-parser and Selected ORM which can be selected from the list.

ORM SUPPORT

  • Mongoose ✔️
  • TypeORM (coming soon) ⚠️

Installation

Either through cloning with git or by using npm (the recommended way):

npm install -g @prkhrv/api-cli

And api-cli will be installed globally to your system path.

Usage

api-cli requires ORM you want to use and it also initializes package.json and installs all the basic dependecies for the Database/ORM.

$ api-cli --install

? Please choose which database ORM to use (Use arrow keys)
❯ mongoose 
? Initialize npm? (y/N) 

 _ __  _ __| | _| |__  _ ____   __
| '_ \| '__| |/ / '_ \| '__\ \ / /
| |_) | |  |   <| | | | |   \ V / 
| .__/|_|  |_|\_\_| |_|_|    \_/  
|_|                               
 ✔ Greetings
 ✔ Initialize npm
 ✔ Copy project files
 ✔ Install dependencies
DONE Project ready


When all the Processes are Completed try running server

node index

Config

Mongoose open ./config/database.config.js and simply add Your MongoDB connection URL.

module.exports = {
   url: 'mongodb://localhost:27017/TestDB' //YOUR LINK HERE
}

License

MIT http://rem.mit-license.org

Contact

PRAKHAR VARSHNEY

About

A CLI Tool which writes all the boiler plate code and installs all the basic Dependencies(Express,body-parser etc) which helps to setup Fast REST APIs.

Topics

Resources

Stars

Watchers

Forks

Packages