Dev_Getting Started on Mac
If you are a developer and want to help build CodaLab, this page will explain how to get started.
CodaLab utilizes Docker(CE) with Python version 2.7 and Django version 1.7, which allows for 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 Docker and other prerequisites.
Assuming a fresh MacOS install the following guide and walk-through should get you started.
1. (OPTIONAL) If you don't have it already, install brew. It allows you to easily install many apps not offered through Apple.
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
If you do not want the entire XCode package due to it's size, you should be able to just download the commmand line tools with:
xcode-select --install
3. ( OPTIONAL ) Install Git. There are several ways to do this. Pick the option best for you:
As of writing this (September 2017) Git is included in XCode
Option 1:
- Download and install from Git: Git Download
Option 2:
- Install with homebrew:
brew install git
Option 3:
- Type
git --versioninto a CLI to get the install prompt for the apple fork. ( Note this will be outdated compared to other methods as Apple maintains this fork)
4. Install Docker-CE for MacOS Docker Install Page
Follow the instruction from the link above to install Docker.
- Download Docker for Mac
- Install and run Docker for Mac
Once Docker has finished installing, it should be visible in the top menu bar as a whale icon.
If Docker is not started, please start it now, and ensure it is working with:
docker run hello-world
If this command returns an error, there is an issue with your setup. If you continue to have problems please create an issue.
After following these steps you should be ready to clone the repository locally, setup the environment variables for it, and run codalab locally in development conditions.