To take advantage of the dev environment that is already configured, you need to have Docker(>= 1.3) and Docker Compose installed.
Install Docker Compose.
$ pip install docker-compose
Clone the repository.
$ git clone https://github.com/unt-libraries/django-name.git $ cd django-name
Start the app and run the migrations.
# start the app $ docker-compose up -d # run the migrations $ docker-compose run --rm web ./manage.py migrate # optional: add a superuser in order to login to the admin interface $ docker-compose run --rm web ./manage.py createsuperuser
The code is in a volume that is shared between your workstation and the web container, which means any edits you make on your workstation will also be reflected in the Docker container. No need to rebuild the container to pick up changes in the code.
However, if the requirements files change, it is important that you rebuild the web container for those packages to be installed. This is something that could happen when switching between feature branches, or when pulling updates from the remote.
# stop the app $ docker-compose stop # remove the web container $ docker-compose rm web # rebuild the web container $ docker-compose build web # start the app $ docker-compose up -d
Running the Tests¶
To run the tests via Tox, use this command.
$ docker-compose run --rm web tox
The Tox configuration will test this app with Django 1.7 - 1.9.
To run the tests only with the development environment (i.e. with Django 1.8).
$ docker-compose run --rm web ./runtests.py
This is the same command that Tox issues inside each test environment it has defined.