Skip to content

Latest commit

 

History

History
76 lines (42 loc) · 2.17 KB

quickstart.md

File metadata and controls

76 lines (42 loc) · 2.17 KB

👈 Back to README

Development Quickstart

This project uses Docker in development. You'll get a lot of benefit by acquainting yourself with Docker and its documentation. However, you can get started on Test Pilot development with a minimum of Docker know-how:

By default js-lint and sass-lint watch options are set to true. If you would like to override these, you can do so in debug-config.json. if you'd like to run linters on pre-commit you can use this pre-commit-hook.

See some of our Tips and Tricks.

First Things First

Make sure you clone the Test Pilot repo:

git clone https://github.com/mozilla/testpilot.git

OS X hosts

  1. Install Docker for Mac

Note: Docker for Mac is pretty new. If you used to use the Docker Toolkit read the transition notes.

  1. Add an entry for testpilot.dev in /etc/hosts:

127.0.0.1 testpilot.dev

  1. Don't forget to cd into your Test Pilot directory:

cd testpilot

  1. Create and setup the Docker containers (this will take some time):

docker-compose up

Ubuntu Linux hosts

  1. Install Docker

  2. Install Docker Compose

  3. Add an entry for testpilot.dev in /etc/hosts:

127.0.0.1 testpilot.dev

  1. Don't forget to cd into your Test Pilot directory:

cd testpilot

  1. Create and setup the Docker containers (this will take some time):

docker-compose up

Windows hosts

  • Help wanted: Getting things working on Windows may be similar to OS X, but the team has little experience with that environment.

Next Steps

  • Start editing files - changes should be picked up automatically.

  • Visit the Django server, using the hostname you added to /etc/hosts:

    http://testpilot.dev:8000/

  • Visit Django admin, login with username admin and password admin:

    http://testpilot.dev:8000/admin/