Overpass

Getting started

Developing

Set Up

• Install node.js. If you're not a fan, don't worry--we're just using it to manage Javascript modules on the client side. Nothing server side here!
• Install the brunch framework globally

    npm install brunch -g

• Clone this repository

    git clone git://github.com/EDesignLabs/Overpass.git
    cd Overpass

• Install the modules Overpass needs

    npm install

• Set your backend server address in the environment variables

    export BASE_API_URL=http://localhost:5000

• Fire up your brunch test server

    brunch w -s

• Check out your handywork at http://localhost:3333 (or another port, if you changed it with the brunch -p option.)
• Try making a change to app/assets/index.html and saving the file. Your browser refreshes automagically with the change! Brunch in action!
• Many changes can be made right inside the app/assets directory, which works pretty much like any other webroot.

Branching

• Add the main EDesignLabs Overpass upstream repo as a remote on your local repo. You only ever need to do this once:

    git remote add upstream git://github.com/EDesignLabs/Overpass.git

• From then on, every time you want to add a new feature or fix a bug, create a new branch based on the latest from upstream (do not work off your own master branch)!

    git fetch upstream
    git checkout upstream/master -b name-of-your-feature-branch

• Install the latest modules Overpass needs, in case there have been changes

    npm install

• Update the existing modules Overpass needs, in case there have been changes

    npm update

• Once you've finished your work and have added and commited your changes locally, push to your own origin repo:

    git push origin name-of-your-feature-branch

• Finally, go to GitHub and submit a pull request from your new branch. You or a teammate can then review the request and merge it cleanly into the main EDesignLabs master!

Deploying

• Install the heroku toolbelt. It's a ridiculously simple way to set up a test server.
• Create a heroku app from inside your Overpass repo's directory

    cd /path/to/Overpass
    heroku create

• Push Overpass to heroku

    git push heroku master

• Open your shiny new web app in the browser!

    heroku apps:open

• Be sure that you have the experimental user-env-compile feature activated

    heroku labs:enable user-env-compile -a your-heroku-app

Details

Languages

• CoffeeScript
• Stylus
• Handlebars

Features

• Swag v0.1.7
• Font Awesome v2.0
• Modernizr v2.6.1
• Brunch Auto-Reload v1.3.2
• Backbone-Mediator
• Lodash v0.8.2
• HTML5 Boilerplate v3.0.0
• Coffeelint 1.4.4

License

This project was grown out of EDesign Lab and released under the MIT license. See LICENSE for detail.

EDesign Lab is a collaborative of educators and technologists to prototype new forms of digital learning for k12 public education. This prototype has been developed through a rapid design cycle, user tested with youth, and built with a focus on educator and learner voices/ needs. Our goal is to offer a blueprint for digital learning applications; we encourage contributions to this project as well as independent forks that can change the future of education.