Git Product home page Git Product logo

node-es6-api-boilerplate's Introduction

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 [email protected].

License

MIT LICENSE

node-es6-api-boilerplate's People

Contributors

bvipul avatar pratik916 avatar viralsolani avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

pratik916 bvipul

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.