1.0.0 • Published 5 years ago

create-api-server v1.0.0

Weekly downloads
2
License
ISC
Repository
github
Last release
5 years ago

create-api-server

A command line application to create a node and express api server with boilerplate files and directories

Installation

Using NPM

npm i -g

Git Clone (Recommended)

Clone the repo into a directory first, this will allow you to configure the config.js file with your own details/variables to be written After editing install as usual with npm i -g

Usage

From your current working directory type create-api-server into the command line to start The command line can take two arguments, folderName and dbName folderName = the root directory of the application and the title of the application in package.json dbName = the name of the local instance of mongodb you would like to use

Example

create-api-server --folderName="my-api" --dbName="mydatabase"

This will create a folder name my-api in your current working directory. In package.json the package name will appear as my-api In your new project, your database location can be found in config/keys.js as mongoURI In this example mongoURI will be equal to mongodb://127.0.0.1:27017/mydatabase