Development and Building
Below are instructions for building the book editor yourself and a layout of how the code is organized.
Building Yourself
- Download and extract (if necessary)
- Run
npm install
or justbower install
in the directory to download and install dependencies - Start up a webserver
Building Documentation
Documentation is built using docco
.
find . -name "*.coffee" | grep -v './bower_components/' | grep -v './node_modules' | xargs ./node_modules/docco/bin/docco
Check the ./docs
directory to read through the different modules.
Directory Layout
scripts/collections/
Backbone Collectionsscripts/configs/
App and 3rd party configsscripts/controllers/
Marionette Controllersscripts/helpers/
Miscellaneous helper functionsscripts/models/
Backbone Models and Marionette Modulesscripts/nls/
Internationalized stringsscripts/routers/
Marionette Routersscripts/views/
Backbone and Marionette Viewsscripts/views/layouts/
Marionette Layoutsscripts/app.coffee
Marionette Applicationscripts/config.coffee
Requirejs Configscripts/main.js
Initial Requirejs Loaderscripts/session.coffee
Model of Sessionstyles/
LESS and CSS Stylingtemplates/
Handlebars Templatestemplates/helpers/
Handlebars Helperstest/
Testable mock data and scriptsindex.html
App's HTML Page
License
This software is subject to the provisions of the GNU Affero General Public License Version 3.0 (AGPL). See license.txt for details. Copyright (c) 2013 Rice University