Skip to content

Dev_Getting Started on Windows

Tyler edited this page Sep 8, 2017 · 20 revisions

If you are a developer and want to help build CodaLab, this page will explain how to to get started.

Installing Prerequisites for Windows

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, and running the CodaLab site in a local virtual environment.

Assuming a fresh Windows install the following guide and walk-through should get you started.

1. Install Git for Windows.

There are several ways to do this on Windows as with Mac. Pick the option best for you:

Git Install Guide

2. Install Docker-CE for Windows Docker Install Page

Note: Docker for Windows has much higher hardware requirements/OS requirements. Please make sure you meet all requirements. The current version of Docker for Windows (as of September 2017) runs on 64bit Windows 10 Pro, Enterprise and Education (1511 November update, Build 10586 or later). In the future Docker will support more versions of Windows 10. If your windows system does not meet these requirements, install Docker toolbox instead: Docker Toolbox Instructions

Docker Toolbox is an installer for quick setup and launch of a Docker environment on older Mac and Windows systems that do not meet the requirements of the new Docker for Mac and Docker for Windows apps.

If you do meet the full requirements for Windows, follow the instruction for the link labeled Docker Install Page above to install Docker.

  • Download Docker for Windows
  • Install and run Docker for Windows

Docker for Windows will not automatically Start. Start it now by searching for Docker in the searchbar. The Docker whale icon should not be visible in the notifications area in the bottom right corner. You should also receive a pop-up.

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.

Clone this wiki locally