burt202 / crud-list

CRUD List App

A simple NodeJS app, that I am using as a playground to try out and new technologies and frameworks.

Technologies Currently Used

• Server-side - NodeJS
• Database - MongoDB
• Client-side - BackboneJS (with MarionetteJS), RequireJS
• Task Runner - GulpJS
• Client-side testing - Mocha, Chai and Sinon
• Client-side coverage - Istanbul
• Client-side dependency manager - Bower
• API documentation - Swagger UI
• API testing - Supertest
• UI testing - PioneerJS

Installation

• Make sure NodeJS and MongoDB are installed
• Run npm install and bower install for dependencies
• install gulp globally sudo npm install -g gulp
• Start app by running gulp

Gulp Tasks

• see gulpfile.js for a list of available tasks

API Documentation

• After running bower install, edit /public/bower_components/swagger-ui/dist/index.html and change the url towards the top of the file to http://node.github.dev:8000/api-desc/
• Then go to http://node.github.dev:8000/api-docs/ in a browser