The Blue Alliance
The Blue Alliance is a FIRST Robotics tool to help teams scout for, compete at, and relive competitions. You can see how the whole site works here, or even write code to make it better!
- Join https://groups.google.com/forum/#!forum/thebluealliance-developers to stay up to date with development
- Fork this project!
- Make your changes on a branch.
- Make changes!
- Send pull request from your fork.
- We'll review it, and push your changes to the site!
If you're having trouble getting set up, reach out to us at our mailing list and we'll help you through it!
- Learn a bit about Git and Github:
- Install App Engine
- Specifically use the Python SDK
- Run installer and allow it make symbolic links (you will be asked to enter your root password)
- Get the latest version of The Blue Alliance
- First make sure you have forked TBA by clicking on "Fork" in the top right of the page
git clone git://github.com/username/the-blue-alliance.gitwhere username is your GitHub username
- For detailed instructions see the GitHub guide on contributing
- Import the project into Google App Engine Launcher
- By default TBA uses port 8088, make sure your local setup is consistent with this
- Run the app in App Engine
- Get some test data: In your terminal console, from the
the-blue-alliancedirectory, run the following command
paver setup(Make sure that you already have Paver installed)
- You should now have a basic development installation!
Paver is an easy way automate repetitive tasks. For The Blue Alliance, these tasks are stored in pavement.py. To install paver, use one of the methods below:
- Download and install paver from http://pypi.python.org/pypi/Paver/
paver clean- Deletes artifacts that the app creates that you don't need.
CSS Icon Sprites
If possible, icons are combined into single files called sprites to reduce the number of requests needed to render a page. To simplify development, we add icons normally (not to the sprite), and every so often we will combine them all into a sprite and fix all necessary CSS. Potentially useful: http://spriteme.org/
The CSS files are compiled from LESS to ease in development. Make sure you have Node Package Manager installed, and install lessc by running
npm install less. Now, you can run
paver less to compile the LESS into CSS.
paver make(builds both LESS and JS)
Testing is implemented using a combination of unittest2 and the Google App Engine testbed framework. Test coverage is a work in progress, and focuses on maintaining datafeed integrity in the face of optimizations and changes to FIRST's data formats.
To run the tests, or just the offline (fast) tests: