Connexions

Development and Building

Below are instructions for optimizing the site and a layout of how the code is organized.

Hosting Yourself

1. Download and extract (if necessary)
2. Install Node.js (and npm) if necessary
3. Run npm install to install test and build dependencies
4. (optional) Run tests with npm test
5. Build the production code with npm run build
6. Configure your server to point at dist/index.html

• Note: You can also host the development version at site/index.html (no build required)

Directory Layout

• site/ Development version of the site
• site/data/ Hardcoded data
• site/images/ Images used throughout the site
• site/scripts/ Site scripts and 3rd party libraries
• site/scripts/collections Backbone Collections
• site/scripts/helpers Helpers for Handlebars, Backbone, and generic code
• site/scripts/libs 3rd Party Libraries
• site/scripts/models Backbone Models
• site/scripts/modules Self-contained, Reusable Modules used to construct pages
• site/scripts/pages Backbone Views representing an entire page (or the entire viewport)
• site/scripts/config.js Require.js configuration
• site/scripts/loader.coffee App loader, responsible for setting up global listeners
• site/scripts/main.js Initial script called by Requirejs
• site/scripts/router.coffee Backbone Router
• site/scripts/session.coffee Session state singleton (Backbone Model)
• site/styles/ App-specific LESS variables and mixins
• index.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.