Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.3 KB

quickstart_for_developers.md

File metadata and controls

42 lines (29 loc) · 1.3 KB

Quickstart for developers

hoodie.js uses grunt.js for automation and phantomJS headless testing.

  # install phantomJS for testing
  brew update && brew install phantomjs

That's all you need. Make your changes, run the test, send a pull request, win karma. We've lots to give

  grunt concat               # Build lib/
  grunt watch                # Build lib/ and watch for changes
  grunt test                 # Run all test
  grunt build                # build hoodie.min.js
  grunt docs                 # create docs from code

hoodie backend (server)

If you want to run a hoodie server locally, you need hoodie app.

The hoodie server is a couchDB instance with some workers listening to changes and doing things like creating databases for users or sending emails. hoodie.js is talking directly with the couchDB api.

Here is a list of requests that hoodie.js is sending:

  • POST, DELETE /_session
  • GET, PUT, DELETE /_users/username
  • GET /user_database/_changes
  • POST /user_database/_bulk_docs
  • GET, PUT, DELETE /user_database/id

not yet, but probably soon

  • GET /user_database/_design/doc/_view/name
  • PUT /user_database/_design/doc/_update/name/id