Add docker setup for Tin (#98)

Closes #93 

- redis, celery worker, and django service
- Uses `watchfiles` to reload on the change of python files in the `tin`
directory.

---------

Co-authored-by: Krishnan Shankar <krishnans2006@gmail.com>

Author: JasonGrace2282

.github/workflows/ci.yml

@@ -21,7 +21,6 @@ jobs:
         image: redis
         ports:
           - 6379:6379
-        options: --entrypoint redis-server
 
     steps:
       - name: Set up repo

.gitignore

@@ -16,3 +16,5 @@ docs/source/reference/
 
 # from prettier
 node_modules/
+
+celerybeat-schedule

Dockerfile

@@ -0,0 +1,15 @@
+FROM python:3.11-slim-bookworm
+
+ENV PYTHONUNBUFFERED=1 PIPENV_VENV_IN_PROJECT=1 C_FORCE_ROOT=1
+
+COPY Pipfile .
+COPY Pipfile.lock .
+
+RUN apt-get update -y && apt-get install -y --no-install-recommends curl firejail bubblewrap
+
+RUN pip install pipenv && \
+  pipenv install --dev
+
+ENV PATH="/.venv/bin:$PATH"
+
+WORKDIR /app

Pipfile

@@ -34,6 +34,7 @@ furo = "*"
 myst-parser = "*"
 sphinx-copybutton = "*"
 sphinxcontrib-django = "*"
+watchfiles = "*"
 
 [ci]
 pytest-cov = "*"

Pipfile.lock

@@ -0,0 +1,54 @@
+services:
+  redis:
+    container_name: tin_redis
+    image: redis:latest
+    networks:
+      - tin-network
+    expose:
+      - "6379"
+
+  celery:
+    container_name: tin_celery
+    image: tin-base
+    entrypoint:
+      - watchfiles
+      - --filter
+      - python
+      - celery -A tin worker
+      - /app/tin
+    networks:
+      - tin-network
+    depends_on:
+      - redis
+    volumes:
+      - .:/app
+    environment:
+      IN_DOCKER: true
+
+  django:
+    container_name: tin_django
+    build: .
+    image: tin-base
+    restart: on-failure
+    networks:
+      - tin-network
+    ports:
+      - 8000:8080
+    depends_on:
+      - celery
+      - redis
+    volumes:
+      - .:/app
+    entrypoint:
+      - ./manage.py
+      - runserver
+      - 0.0.0.0:8080
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://0.0.0.0:8080"]
+    environment:
+      IN_DOCKER: true
+
+networks:
+  tin-network:
+    driver: bridge
+    name: tin-dev-network

compose.yaml

@@ -43,21 +43,12 @@ Now you're all set! Try running the development server
 Head on over to `http://127.0.0.1:8000 <http://127.0.0.1:8000>`_, and login
 as ``admin`` and the password you just entered.
 
+Docker
+------
+If you prefer, you can also run the development setup with `Docker <https://www.docker.com/>`_. To do so,
+``cd`` into the project directory and run::
 
+    docker compose build
+    docker compose up
 
-NixOS Setup
------------
-A ``flake.nix`` file is provided for NixOS users. To use it, first enable the redis service globally.
-Place the following in your ``/etc/nixos/configuration.nix``::
-
-  services.redis.server."".enable = true
-
-This will start a systemd service called ``redis``. After that, you can start the flake with::
-
-  nix develop
-
-You can then install dependencies, setup the database, and run the development server as described above.
-
-.. tip::
-
-   You may also need to set ``nix.settings.experimental-features = ["nix-command" "flakes"];`` in your ``configuration.nix``.
+The latter command will start up the django development server, as well as celery tasks for submissions.