API for the badeseen mobile app
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
api
dashboard
doc
lib
models
scripts
test
trigger
.gitignore
.jshintignore
Gruntfile.js
Makefile
README.md
index.js
package.json

README.md

badeseenservice strider build badge

Installation

Prerequisites

This project relies on node.js and mongodb. It both of them are installed, run npm install to fetch all dependencies.

Development

While developing you should use grunt watch for direct feedback. Before committing anything you should run grunt beautify.

Testing

Run make test for unit tests.

Generate API documentation

Install apiDoc first (npm install -g apidoc). Then run apidoc -i api/. The documentation can then be found under doc/