Introduction

An API Boilerplate in Node to create a ready-to-use REST API in seconds

Pre-requisites

Node v7.6+

Installation

Clone the repository

`git clone https://github.com/viralsolani/node-es6-api-boilerplate.git`

Switch to the repo folder

`cd node-es6-api-boilerplate`

Run the npm installation script

`npm i or npm install`

Copy .env.sample file and create .env file, and change the values according to your configuration like:

DB_CONNECTION=mysql
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=nodeboilerplate
DB_USERNAME=root
DB_PASSWORD=root

After successfull installation of the project run:

`npm run seed`

Now run the project on the browser by running:

`npm start`

Issues

If you come across any issues please report them here.

Contributing

Feel free to create any pull requests for the project. For proposing any new changes or features you want to add to the project, you can send us an email at viral.solani@gmail.com.

License

MIT LICENSE