Merge branch 'feature/render-final' into develop

JosueCustodio · May 14, 2022 · e472aba · e472aba
2 parents 7224d07 + f96cb47
commit e472aba
Show file tree

Hide file tree

Showing 27 changed files with 450 additions and 248 deletions.
diff --git a/.github/CHANGELOG.rst b/.github/CHANGELOG.rst
@@ -6,6 +6,7 @@ Change Log
 ---------
 *Release date: TBD*
 
+- Added the ability to deploy to Render as a 1-click Heroku-like deployment option
 - Round weights can be modified within tournament preferences, rather than just by the Edit Database.
 - Preformed panels can now be applied 'directly', in a linear top-to-bottom fashion. However, this method will not account for soft or hard conflicts. Thanks to Enting Lee for the pull request!
 

diff --git a/.github/README.md b/.github/README.md
@@ -19,7 +19,7 @@ Tabbycat is a draw tabulation system for British Parliamentary and a variety of
 
 ## 🔍 Features
 
-- Deployable to [Heroku](https://www.heroku.com/) for an easy, fast, and free setup
+- A range of setup options. Tabbycat powers Calico, a paid service for hosting tournaments. Tabbycat can also run as a local installation (natively, or via Docker) and be deployed to the free-tiers of the Render or Heroku platforms.
 - Enter data from multiple computers simultaneously and (optionally) display results, draws, and other information online
 - Collect ballots and feedback online, or from printed forms customised for each round ( adjudicator feedback questions and rankings [are configurable](http://tabbycat.readthedocs.io/en/stable/features/adjudicator-feedback.html))
 - Automated adjudicator allocations based on adjudicator ranking, debate priority, and conflicts/clashes
@@ -33,13 +33,17 @@ Our user guide is at [tabbycat.readthedocs.io](http://tabbycat.readthedocs.io/).
 
 ## ⬆️ Installation
 
-Tabbycat can be deployed in a number of ways. While you can set it up to [run on your own computer](https://tabbycat.readthedocs.io/en/stable/install/local.html) most users will want to run it as a website.
+Tabbycat can be deployed in a number of ways.
 
 [Calico](https://calicotab.com/) is a managed hosting service run by one of Tabbycat's developers. For a flat fee, it will host tab websites, automatically manage their setup and performance, and provide ongoing access to the released tab. Click this button to deploy to Calico:
 
 [![Deploy](https://raw.githubusercontent.com/gist/tienne-B/fc04ecd3c11a38424b642b4bba60e8d9/raw/b2c71d7d6a0d368d3e9dfd8002af729d155ad09b/calicodeploy.svg)](https://calicotab.com/tournaments/new/)
 
-Tabbycat is **currently unavailable as a 1-click installation** on the [Heroku](https://www.heroku.com) web platform. If you are unable to use Calico, we suggest [creating a local installation](https://tabbycat.readthedocs.io/en/stable/install/local.html). We hope to address this issue or [develop an alternate installation method](https://tabbycat.readthedocs.io/en/feature-render/index.html) in a future version of Tabbycat.
+Tabbycat is **no longer available as a 1-click Heroku installation**. If you do not want to use Calico, you have a few alternate options:
+
+1. For online tournaments where long-term data preservation is unnecessary, we have [a 1-click installer that uses the Render platform](https://tabbycat.readthedocs.io/en/stable/install/render.html) and runs within its free tier of services
+2. For tournaments where online access is unnecessary, you can [install and run Tabbycat from your own computer](https://tabbycat.readthedocs.io/en/stable/install/local.html)
+3. For online tournaments in general, you can still deploy to Heroku, [but will need to run a script from your computer's command line](https://tabbycat.readthedocs.io/en/stable/install/heroku.html)
 
 ## 💪 Support and Contributing
 

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -19,9 +19,6 @@ updates:
   - dependency-name: ipython
     versions:
     - "< 6.6, >= 6.5.a"
-  - dependency-name: scout-apm
-    versions:
-    - "< 1.2.4, >= 1.2.3.a"
   - dependency-name: selenium
     versions:
     - "< 3.14.1, >= 3.14.0.a"

diff --git a/.github/workflows/django.yml b/.github/workflows/django.yml
@@ -25,6 +25,10 @@ jobs:
         ports: ['5432:5432']
         options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
 
+    env:
+      ## Environment variable
+      GITHUB_CI: true # Just 'CI' clashes with Render
+
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python

diff --git a/Dockerfile b/Dockerfile
@@ -6,6 +6,8 @@ FROM python:3.9
 
 # Just needed for all things python (note this is setting an env variable)
 ENV PYTHONUNBUFFERED 1
+# Needed for correct settings input
+ENV IN_DOCKER 1
 
 # Setup Node/NPM
 RUN apt-get update

diff --git a/Pipfile b/Pipfile
@@ -19,7 +19,8 @@ django-summernote = "*"
 dj-cmd = "*"
 django-redis = "*"
 django-cors-headers = "*"
-psycopg2 = "*"
+psycopg2-binary = "*"
+asgiref = "*"
 channels = "*"
 channels-redis = "*"
 ipython = "==7.*"
@@ -34,6 +35,7 @@ dj-database-url = "*"
 honcho = "*"
 gunicorn = "*"
 sentry-sdk = "*"
+whitenoise = "*"
 
 [dev-packages]
 pre-commit = "*"

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/app.json b/app.json
diff --git a/bin/artillery-draw.yml b/bin/artillery-draw.yml
@@ -8,7 +8,6 @@
 #   PUBLIC_FAST_CACHE_TIMEOUT=30
 #   PUBLIC_SLOW_CACHE_TIMEOUT=30
 #   TAB_PAGES_CACHE_TIMEOUT=30
-#   SCOUT_MONITOR=false
 #   Hobby dynos
 # Note that a single heroku dyno has a hard limit of 50 requests in its backlog;
 # testing limits should not exceed that (say 40 to account for latency?) else

diff --git a/bin/artillery-tab.yml b/bin/artillery-tab.yml
@@ -8,7 +8,6 @@
 #   PUBLIC_FAST_CACHE_TIMEOUT=30
 #   PUBLIC_SLOW_CACHE_TIMEOUT=30
 #   TAB_PAGES_CACHE_TIMEOUT=30
-#   SCOUT_MONITOR=false
 #   Hobby dynos
 # Note that a single heroku dyno has a hard limit of 50 requests in its backlog;
 # testing limits should not exceed that (say 40 to account for latency?) else

diff --git a/bin/render-compile.sh b/bin/render-compile.sh
@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+# exit on error
+set -o errexit
+
+echo "-----> Install dependencies"
+python -m pip install pipenv
+pipenv install --system
+
+echo "-----> I'm post-compile hook"
+cd ./tabbycat/
+
+echo "-----> Running database migration"
+python manage.py migrate --noinput
+
+echo "-----> Running dynamic preferences checks"
+python manage.py checkpreferences
+
+echo "-----> Running static asset compilation"
+npm install -g @vue/cli-service-global
+npm install
+npm run build
+
+echo "-----> Running static files compilation"
+python manage.py collectstatic --noinput
+
+echo "-----> Post-compile done"
diff --git a/bin/serve_local b/bin/serve_local
diff --git a/deploy_heroku.py b/deploy_heroku.py
@@ -179,7 +179,7 @@ def get_git_push_spec():
 run_heroku_command(["buildpacks:add", "heroku/python"])
 
 # Set config variables
-command = ["config:set", "DISABLE_COLLECTSTATIC=1", "ON_HEROKU=1"]
+command = ["config:set", "DISABLE_COLLECTSTATIC=1", "ON_HEROKU=1", "USING_NGINX=1"]
 secret_key = get_random_secret_key()
 
 if platform.system() == "Windows": # Windows shell needs escaping

diff --git a/docker-compose.prod.yml b/docker-compose.prod.yml
@@ -18,9 +18,11 @@ services:
       - DEBUG=0
       - DOCKER_REDIS=1
       - IN_DOCKER=1
+      - USING_NGINX=1
 
   worker:
     environment:
       - DEBUG=0
       - DOCKER_REDIS=1
       - IN_DOCKER=1
+      - USING_NGINX=1
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -39,6 +39,7 @@ services:
       - IN_DOCKER=1
       - DISABLE_SENTRY=1
       - DOCKER_REDIS=1
+      - USING_NGINX=1
     ports:
       - "127.0.0.1:8000:8000"
     volumes:
@@ -57,6 +58,7 @@ services:
       - IN_DOCKER=1
       - DISABLE_SENTRY=1
       - DOCKER_REDIS=1
+      - USING_NGINX=1
     volumes:
       - ./tabbycat/settings:/tcd/tabbycat/settings
     working_dir: /tcd

diff --git a/docs/index.rst b/docs/index.rst
@@ -19,6 +19,7 @@ formats too. If you're looking for a general overview of the software, check out
    :maxdepth: 1
    :caption: Installation
 
+   install/render
    install/heroku
    install/local
    install/docker