https://github.com/viralsolani/node-es6-api-boilerplate
An API Boilerplate in Node to create a ready-to-use REST API in seconds
https://github.com/viralsolani/node-es6-api-boilerplate
api-boilerplate es6 node-api nodejs
Last synced: 9 months ago
JSON representation
An API Boilerplate in Node to create a ready-to-use REST API in seconds
- Host: GitHub
- URL: https://github.com/viralsolani/node-es6-api-boilerplate
- Owner: viralsolani
- License: mit
- Created: 2018-08-11T09:49:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-20T06:22:59.000Z (about 7 years ago)
- Last Synced: 2025-02-08T22:28:26.380Z (11 months ago)
- Topics: api-boilerplate, es6, node-api, nodejs
- Language: JavaScript
- Size: 441 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/viralsolani/node-es6-api-boilerplate/issues).
## 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](https://github.com/viralsolani/node-es6-api-boilerplate/blob/master/LICENSE)