Dev_Getting Started on Mac
Clone this wiki locally
If you are a developer and want to help build CodaLab, this page will explain how to to get started.
To use and test the submission process, a queue server will need to be installed. RabbitMQ installs easily on a Mac and requires no configuration out of the box for testing purposes. A database besides SQLite is recommended. MySQL and Postgres work on Windows, Linux and Mac.
CodaLab is built with Python, supporting development on local machines with Windows, Linux, Mac and BSD. If something is broken, please open a new issue.
In this section, we will walk you through installing Python 2.7.x, installing prerequisites, and running the CodaLab site in a local virtual environment.
Install Python 2.7.
sudo easy_install python-pip
sudo easy_install virtualenv
Install GCC. XCode Menu > Preferences > Downloads > Install Command Line Tools
Install Docker to start mysql quickly. (Optional)
Install Compass (optional)
If you want to make changes to CodaLab's stylesheets via SCSS files, you will need to install Compass. Note that this step is only required if you plan to make any changes to stylesheets.
Install Ruby from http://rubyinstaller.org/downloads/. (Version 1.9.3 is recommended). During installation be sure to select the option to add Ruby to your PATH.
Open a command window and install compass by executing:
sudo gem install compass
Take the following steps to generate the css files after you've made changes to the scss files in the sass folder:
Or to start a process which will automatically re-generate the files when changes are made:
compass watch .
Install Java from https://www.java.com/en/download/.
Add Java bin folder to the PATH environment variable.
Download and extract Closure from http://dl.google.com/closure-compiler/compiler-latest.zip.
You can also make this easier by
pip install watchdog and then: