ES6 Node Rest API boilerplate with Mongo Datastore
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app async/await (#1) Jan 26, 2017
tests remove extraneous user spec Feb 10, 2017
.babelrc async/await (#1) Jan 26, 2017
.eslintignore async/await (#1) Jan 26, 2017
.eslintrc async/await (#1) Jan 26, 2017
.gitignore
.travis.yml async/await (#1) Jan 26, 2017
History.md changelog v0.9.1 Jan 25, 2017
LICENSE move api to routes folder Oct 25, 2016
README.md Fix typo in .env example Mar 9, 2017
index.js async/await (#1) Jan 26, 2017
package.json 0.10.0 Jan 26, 2017

README.md

Express & ES6 API Boilerplate

Build Status

Tested on Node v6 and above

Features

  • ES6 for the latest & greatest javascript awesomeness
  • MongoDB w/ Mongoose for data layer
  • Testing via Mocha & Chai
  • Test coverage via Isparta
  • Username/Email registration and authentication

Getting Started

First, ensure you have node and mongo installed on your system.

# clone it
git clone git@github.com:kylealwyn/node-rest-api-boilerplate.git
cd node-rest-api-boilerplate

# Make it your own
rm -rf .git && git init

# Install dependencies
npm install

# Run it
npm start

# Try it!
curl -H "Content-Type: application/json" -X POST -d '{"username":"jamesdean", "email": "example@gmail.com", "password":"password1"}' http://localhost:4567/users

Environment Variables

Place a .env file in the top level of the directory you've cloned. These variables will be automatically assigned to process.env when the application boots. It is gitignored by default as it's not good practice to store your environment variables in your remote repository. Your .env file can look something like this:

MONGO_URI=mongodb://somewhere:27017
SESSION_SECRET=lolthisissecret

Now we can access one of these variables with something like process.env.MONGO_URI!

NPM Scripts

  • npm start - Start live-reloading development server
  • npm test - Run test suite
  • npm run test:watch - Run test suite with auto-reloading
  • npm run coverage - Generate test coverage
  • npm run build - Generate production ready application in ./build

Todo

  • Add OAuth Login Support (Facebook, Twitter, Google)
  • Add support for MySql or PostgreSQL (Possibly with sequelize)
  • Reset password functionality

License

MIT