riak / demo / stickynotes / README

Stickynotes is a demo Riak application.

Running
---

cd $RIAK_HOME  # base of your riak installation
./start-fresh demo/stickynotes/riak-config.erlenv
cd demo/stickynotes
make
./start.sh

Now point your browser at http://localhost:8000/

You should see a dark grey page with a few controls
at the top.  Start clicking!


Structure
---

Stickynotes starts a Webmachine node, which exposes a simple
file-serving resource, as well as jiak_resource and jaywalker_resource
from Riak.  The files you'll find here:

/
 Makefile            - for rebuilding things
 README              - this file
 riak-config.erlenv  - Riak cluster configuration file for Stickynotes
 start.sh            - start the Stickynotes application
 start-dev.sh        - start Stickynotes with auto-module-reloading
 deps/
   riak              - symlink to riak for code path loading
 priv/www/
   index.html        - the HTML you see at /
   css/
     application.css - the CSS you see at /
   images/           - all of the images
   js/
     application.js  - the logic running the page
     jiak.js         - libary for querying Riak through Jiak
     jquery*.js      - jQuery
     json2.js        - JSON library
 src/
   groups.erl        - the Jiak bucket module for groups objects
   notes.erl         - the Jiak bucket module for notes objects
   stickynotes.app   - application configuration (this is where
                       riak_ip, _port, _cookie are set)
   stickynotes.erl   - top application file
   stickynotes_app.erl - application start file
   stickynotes_deps.erl - utilities for getting beams from other
                            applications loaded in Stickynotes
   stickynotes_resource.erl - simple file-serving resource
   stickynotes_sup.erl - supervisor that starts the Webmachine node
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.