Developers' README

File Structure

app everything required during runtime
- controllers controllers for each route
- validator used to validate incoming JSON
- model database abstraction layer
test all test cases
- unit simple unit tests
- functional test for single controller actions
- integration testing the whole system, typically multiple controller actions
- data experience api test suite

install couchDB, see here
run coffee app/database/init/db_init.coffee inside the main-folder. This action will create a DB named "wt2" and fill it with sample data and views.
results of the views:
- views of the view group find by:
  - find documents by UUID. Example: find documents with UUID-mailbox "mailto:happy@happyplace.com". link
  - find documents by verb TODO make TinCanAPI conform.
  - find documents by timestamp. Example: find documents with timestamp "2013-12-02T06:43:28.922Z". link
  - find documents by stored date. Example: find documents with stored date "2013-12-02T06:41:05.344Z". link
  - find documents by activity ID. Example: find the document with activity ID "8d9aa781-8790-46f2-b9f8-9564ac95548d". link
  - You can use startkey, endkey and some other parameters. See more infos here
- views of the view group counter:
  - number of all documents stored in the db: link
  - number of documents stored at one day. Example: number of documents, created at "2013-12-02" link

a useful vim script that adds syntax highlighting, indentation and compilation support for Coffeescript. Installation is explained on the site, but pathogen users can just clone this URL into their bundle directory.
to conform to our style guide, use these settings in your .vimrc, perhaps only for files with .coffee extension:

set expandtab

set tabstop=2