Skip to content

suvankar-kundu/node-express-es6-boilerplate

Repository files navigation

Node, Express & ES6 REST API Starter Kit

This is a straightforward starter kit for building REST APIs with ES6 and Express.This project contains the following.

  • HTTP API server using Express
  • CORS support
  • Best Practice Structure
  • JWT middleware for authorization
  • ES6 support via babel
  • Body Parsing via body-parser

Getting Started

1. Clone repo    
`git clone https://github.com/suvankar-kundu/node-express-es6-boilerplate.git <dir_name>`    

2. Change directory    
`cd <dir_name>`    

3. Remove git folder    
*nix: `rm -rf ./.git`    
win: `RD /S /Q .git`    

4. Edit **package.json**    
Change `name, version, description, repository, author, bugs, homepage`    

5. Install packages    
`npm install`    

6. Update packages    
`npm update`    

Command

  1. Run npm run build
    Transpile ES6 to dist directory.

  2. Run npm run start
    This will start the application with specific port.

  3. Run npm run lint
    This will check eslint error.

  4. Run npm run test
    This will run all the test cases.

License

MIT