Merge pull request #945 from dancerfly/docker-compose

Docker compose

Author: harrislapiroff

Dockerfile

@@ -0,0 +1,10 @@
+FROM python:2
+ENV PYTHONUNBUFFERED 1
+RUN pip install pipenv
+RUN mkdir /django
+WORKDIR /django
+COPY Pipfile* /django/
+RUN pipenv install
+COPY . /code/
+ENTRYPOINT ["bin/docker-entrypoint.sh"]
+CMD ["./manage.py", "runserver", "0.0.0.0:8000"]

README.rst

@@ -11,8 +11,49 @@ Naming
 
 The name of this software is django-brambling. The name for use within the content of the application and for marketing purposes is Dancerfly.
 
-Development
-=============
+Development Using Docker Compose
+================================
+
+As of April 2020, Dancerfly experimentally allows you to use Docker Compose to spin up a development environment with one line. If you prefer to use the older method of relying on your system Python, skip below to "Development Using System Python."
+
+Prerequisites
+-------------
+
+These instructions assume you have the following software on your machine:
+
+* `Docker Compose <https://docs.docker.com/compose/install/>`_
+
+Installation instructions
+-------------------------
+
+Here's a one-liner to get you going. This runs a database container using PostgreSQL and an application container with the Django application. It will run the necessary initial database migrations.
+
+.. code:: bash
+
+   docker-compose up
+
+Quick Tips
+----------
+
+Use ``docker-compose exec`` to run commands on a currently running application container or ``docker-compose run`` to start a container and run a command:
+
+.. code:: bash
+
+   docker-compose exec ./manage.py makemigrations
+   docker-compose run pipenv install bleach
+
+You can attach interactively to the Django process using this command:
+
+.. code:: bash
+
+   docker attach (docker-compose ps -q django)
+
+Learn more about Docker Compose in `the documentation <https://docs.docker.com/compose/>`_.
+
+Development Using System Python
+===============================
+
+Use these instructions if you'd rather not use Docker Compose.
 
 Prerequisites
 -------------

bin/docker-entrypoint.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -e
+
+pipenv run ./manage.py migrate
+pipenv run $@

docker-compose.yaml

@@ -0,0 +1,22 @@
+version: '3.7'
+services:
+    postgresql:
+        image: 'postgres:10.5-alpine'
+        environment:
+            POSTGRES_USER: dancerfly
+            POSTGRES_PASSWORD: dancerflypassword
+            POSTGRES_DB: dancerfly
+        ports:
+            - "127.0.0.1::5432"
+    django:
+        stdin_open: true
+        tty: true
+        ports:
+            - "127.0.0.1:8000:8000"
+        build: .
+        environment:
+            DATABASE_URL: postgres://dancerfly:dancerflypassword@postgresql/dancerfly
+        volumes:
+            - ./:/django
+        depends_on:
+            - postgresql