Source Code - rallyraiser/make-it-together GitHub Wiki

RallyRaiser is hosted at GitHub and uses Git for source control. In order to obtain the source code, you must first install Git on your system. Instructions for installing and setting up Git can be found at https://help.github.com/articles/set-up-git.

If you simply want to create a local copy of the source to play with, you can clone the main repository using this command:

git clone git://github.com/rallyraiser/rallyraiser.git

If you're planning on contributing to RallyRaiser, then it's a good idea to fork the repository. You can find instructions for forking a repository at https://help.github.com/articles/fork-a-repo. After forking the RallyRaiser repository, you'll want to create a local copy of your fork.

Directory structure

The RallyRaiser directory and file structure is as follows:

• demos - collection of demos and sample files
• lib - contains third party libraries for use in the testing
• release - contains the distributable files from the last official release
  • npm - the folder containing all files necessary for publishing to npm
• src - the main source code folder
  • cli - files for the command line interfaces
  • core - core RallyRaiser functionality including the RallyRaiser object
  • formatters - contains files defining the formatters
  • rules - contains files defining the RallyRaiser rules
  • worker - contains files for the RallyRaiser Web Worker
• tests - the main unit test folder
  • core - tests for core RallyRaiser functionality including the RallyRaiser object
  • formatters - tests for the formatters
  • rules - tests for the RallyRaiser rules

The first time you run a build, you'll also notice a build directory is created. This directory is not checked in and has the same structure as the release directory.