node-api-es6-boilerplate
v0.7.1
Published
Starter project for an ES6 RESTful Express API
Readme
Express & ES6 API Boilerplate
Features
- [x] ES6 for javascript awesomeness
- [x] MongoDB w/ Mongoose for data layer
- [x] Username/Email registration and authentication
- [x] Testing via Mocha & Chai
- [x] Test coverage via Isparta
Getting Started
First, ensure you have node and mongo installed on your system.
# clone it
git clone [email protected]:kylealwyn/node-api-es6-boilerplate.git
cd node-api-es6-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": "[email protected]", "password":"password1"}' http://localhost:4567/usersCommands
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- Run test coverage
npm run build- Generates production ready application in
./build
- Generates production ready application in
Todo
- [ ] Add OAuth Login Support (Facebook, Twitter, Google)
- [ ] Add support for MySql or PostgreSQL (Possibly with sequelize)
- [x] Write tests to exemplify Mongo interactions
- [ ] Move all data retrieval logic into services to remove Mongo dependences in controllers
License
MIT
