==================================
Installing the Ubuntu QA Dashboard
==================================

Before you start hacking on the dashboard, you need to first setup your environment.
There are a few different ways to do this.

Vagrant
-------

Requirements
~~~~~~~~~~~~
To get started, you'll need:
 * Vagrant

sudo apt-get install vagrant


Grab the source
---------------

Create the bzr environment for the dashboard with::

    bzr branch lp:qa-dashboard
    cd qa-dashboard

Setting up Vagrant
------------------

Now we're ready to go, so create an environment for the dashboard::

    vagrant up

That creates a clean environment using vagrant.

After Vagrant finishes setting up, you need to ssh into it::

    vagrant ssh

Start developing
~~~~~~~~~~~~~~~~

From inside the vagrant environment, you need to go to where the branch is::

    cd dash

You can now work on the dashboard as you would with any other django site.

Vagrant takes care of all of the setup work. You will have a database that is
pre-populated with data. Depending on how old the snapshot of the database is,
you may need to update the migrations::

    python manage.py migrate

Run the Server
--------------

Now all you need to do is run the server::

    python manage.py runserver 0.0.0.0:8000

Testing
-------

The quick way to run the dashboard's tests::

    ./manage.py test
    
Make sure to write tests for all new code your write and all the tests pass.