From 27a2ed46be46372c24e1f7fa02535ad216519aaa Mon Sep 17 00:00:00 2001 From: Jay Date: Tue, 18 Aug 2015 14:09:32 +0200 Subject: [PATCH] merged upstream changes (resolves merge conflict) --- README.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.rst b/README.rst index 30579d70..3af85733 100644 --- a/README.rst +++ b/README.rst @@ -37,6 +37,7 @@ Features * Pre configured Celery_ (optional) * Integration with Maildump_ for local email testing (optional) * Integration with Sentry_ for error logging (optional) +* Docker support using docker-compose_ for dev and prod .. _Hitch: https://github.com/hitchtest/hitchtest .. _Bootstrap: https://github.com/twbs/bootstrap @@ -51,6 +52,7 @@ Features .. _Celery: http://www.celeryproject.org/ .. _Maildump: https://github.com/ThiefMaster/maildump .. _Sentry: https://getsentry.com +.. _docker-compose: https://www.github.com/docker/compose Constraints @@ -166,6 +168,34 @@ To get live reloading to work you'll probably need to install an `appropriate br It's time to write the code!!! +Getting up and running using docker +---------------------------------- + +The steps below will get you up and running with a local development environment. We assume you have the following installed: + +* docker +* docker-compose + +Open a terminal at the project root and run the following for local development:: + + $ docker-compose -f dev.yml up + +You can also set the environment variable ``COMPOSE_FILE`` pointing to ``dev.yml`` like this:: + + $ export COMPOSE_FILE=dev.yml + +And then run:: + + $ docker-compose up + + +To migrate your app and to create a superuser, run:: + + $ docker-compose run django python manage.py migrate + + $ docker-compose run django python manage.py createsuperuser + + For Readers of Two Scoops of Django 1.8 --------------------------------------------