Merge pull request #58 from HackSoftware/dockerize

Dockerize the project

Author: Ivaylo-Bachvarov

.github/workflows/django.yml

@@ -1,6 +1,19 @@
 name: Django application
 on: [push]
 jobs:
+  docker_build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Build docker
+      run: docker-compose build
+    - name: Type check
+      run: docker-compose run django mypy styleguide_example/
+    - name: Run migrations
+      run: docker-compose run django python manage.py migrate
+    - name: Run tests
+      run: docker-compose run django py.test
+
   build:
     runs-on: ubuntu-latest
     services:
@@ -19,7 +32,7 @@ jobs:
     - name: Fetch history, because Heroku deploy fails otherwise.
       uses: actions/setup-python@v2
       with:
-        python-version: 3.9
+        python-version: 3.10.2
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -30,6 +43,7 @@ jobs:
       run: python manage.py migrate
     - name: Run tests
       run: py.test
+
   deploy_to_heroku:
     runs-on: ubuntu-latest
     needs: build

README.md

@@ -20,7 +20,8 @@ Few important things:
 * It comes with GitHub Actions support, [based on that article](https://hacksoft.io/github-actions-in-action-setting-up-django-and-postgres/)
 * It comes with examples for writing tests with fakes & factories, based on the following articles - <https://www.hacksoft.io/blog/improve-your-tests-django-fakes-and-factories>, <https://www.hacksoft.io/blog/improve-your-tests-django-fakes-and-factories-advanced-usage>
 * It comes with [`whitenoise`](http://whitenoise.evans.io/en/stable/) setup.
-* It can be easily deployed to Heroku.
+* It can be easily deployed to Heroku or AWS ECS.
+* Dockerized for local development with docker-compose.
 * It comes with an example list API, that uses [`django-filter`](https://django-filter.readthedocs.io/en/stable/) for filtering & pagination from DRF.
 * It comes with [`mypy`](https://mypy.readthedocs.io/en/stable/) configured, using both <https://github.com/typeddjango/django-stubs> and <https://github.com/typeddjango/djangorestframework-stubs/>
   * Basic `mypy` configuration is located in [`setup.cfg`](setup.cfg)
@@ -201,7 +202,7 @@ Example data structure:
 }
 ```
 
-## Helpful commands
+## Helpful commands for local development without docker-compose
 
 To create Postgres database:
 
@@ -227,6 +228,26 @@ To start Celery Beat:
 celery -A styleguide_example.tasks beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler
 ```
 
+## Helpful commands for local development with docker-compose
+
+To build and run everything
+
+```
+docker-compose up
+```
+
+To run migrations
+
+```
+docker-compose run django python manage.py migrate
+```
+
+To shell
+
+```
+docker-compose run django python manage.py shell
+```
+
 ## Heroku
 
 The project is ready to be deployed on Heroku. There's a current deployment that can be found - <https://hacksoft-styleguide-example.herokuapp.com/>

docker-compose.yml

@@ -0,0 +1,65 @@
+version: "3.9"
+
+services:
+  db:
+    image: postgres:14.1
+    environment:
+      - POSTGRES_DB=styleguide_example_db
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+
+  rabbitmq:
+    image: "rabbitmq:alpine"
+
+    healthcheck:
+      test: rabbitmq-diagnostics -q ping
+      interval: 30s
+      timeout: 30s
+      retries: 3
+
+  django:
+    build:
+      context: .
+      dockerfile: docker/local.Dockerfile
+    command: python manage.py runserver 0.0.0.0:8000
+    environment:
+      - DATABASE_URL=postgres://postgres:postgres@db:5432/styleguide_example_db
+      - CELERY_BROKER_URL=amqp://guest:guest@rabbitmq:5672//
+    volumes:
+      - .:/app
+    ports:
+      - "8000:8000"
+    depends_on:
+      - db
+      - rabbitmq
+    restart: on-failure
+
+  celery:
+    build:
+      context: .
+      dockerfile: docker/local.Dockerfile
+    command: celery -A styleguide_example.tasks worker -l info --without-gossip --without-mingle --without-heartbeat
+    environment:
+      - DATABASE_URL=postgres://postgres:postgres@db:5432/styleguide_example_db
+      - CELERY_BROKER_URL=amqp://guest:guest@rabbitmq:5672//
+    volumes:
+      - .:/app
+    depends_on:
+      - db
+      - rabbitmq
+    restart: on-failure
+
+  beats:
+    build:
+      context: .
+      dockerfile: docker/local.Dockerfile
+    command: celery -A styleguide_example.tasks beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler
+    environment:
+      - DATABASE_URL=postgres://postgres:postgres@db:5432/styleguide_example_db
+      - CELERY_BROKER_URL=amqp://guest:guest@rabbitmq:5672//
+    volumes:
+      - .:/app
+    depends_on:
+      - db
+      - rabbitmq
+    restart: on-failure

docker/beats_entrypoint.sh

@@ -0,0 +1,2 @@
+echo "--> Starting beats process"
+celery -A styleguide_example.tasks worker -l info --without-gossip --without-mingle --without-heartbeat

docker/celery_entrypoint.sh

@@ -0,0 +1,2 @@
+echo "--> Starting celery process"
+celery -A styleguide_example.tasks beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler

docker/local.Dockerfile

@@ -0,0 +1,15 @@
+# This docker file is used for local development via docker-compose
+# Creating image based on official python3 image
+FROM python:3.10
+
+# Fix python printing
+ENV PYTHONUNBUFFERED 1
+
+# Installing all python dependencies
+ADD requirements/ requirements/
+RUN pip install -r requirements/local.txt
+
+# Get the django project into the docker container
+RUN mkdir /app
+WORKDIR /app
+ADD ./ /app/

docker/production.Dockerfile

@@ -0,0 +1,12 @@
+# This docker file is used for production
+# Creating image based on official python3 image
+FROM python:3.10
+
+# Installing all python dependencies
+ADD requirements/ requirements/
+RUN pip install -r requirements/production.txt
+
+# Get the django project into the docker container
+RUN mkdir /app
+WORKDIR /app
+ADD ./ /app/

docker/web_entrypoint.sh

@@ -0,0 +1,2 @@
+echo "--> Starting web process"
+gunicorn config.wsgi:application -b 0.0.0.0:80

runtime.txt

@@ -1 +1 @@
-python-3.9.6
+python-3.10.2