Merge pull request #6 from HackSoftware/add-heroku-setup

Add Heroku Setup / Production settings

Author: RadoRado

.github/workflows/django.yml

@@ -30,3 +30,14 @@ jobs:
       run: python manage.py migrate
     - name: Run tests
       run: py.test
+  deploy_to_heroku:
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - uses: actions/checkout@v1
+      - name: Deploy to Heroku
+        env:
+          HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
+          HEROKU_APP_NAME: 'hacksoft-styleguide-example'
+        run: git push --force https://heroku:[email protected]/$HEROKU_APP_NAME.git origin/master:master

Procfile

@@ -0,0 +1,4 @@
+release: python manage.py migrate
+web: gunicorn config.wsgi:application
+worker: REMAP_SIGTERM=SIGQUIT celery --without-gossip --without-mingle --without-heartbeat worker -A styleguide_example.tasks -l info
+beat: REMAP_SIGTERM=SIGQUIT celery -A styleguide_example.tasks beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler

README.md

@@ -9,6 +9,8 @@ Few important things:
 * Linux / Ubuntu is our primary OS and things are tested for that. It will mostly not work on Mac & certainly not work on Windows.
 * It uses Postgres as primary database.
 * 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 [`whitenoise`](http://whitenoise.evans.io/en/stable/) setup.
+* It can be easily deployed to Heroku.
 
 ## Helpful commands
 
@@ -35,3 +37,7 @@ To start Celery Beat:
 ```
 celery -A styleguide_example.tasks beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler
 ```
+
+## 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/>

config/settings/base.py

@@ -59,6 +59,7 @@
 
 MIDDLEWARE = [
     'django.middleware.security.SecurityMiddleware',
+    'whitenoise.middleware.WhiteNoiseMiddleware',
     'django.contrib.sessions.middleware.SessionMiddleware',
     'django.middleware.common.CommonMiddleware',
     'django.middleware.csrf.CsrfViewMiddleware',
@@ -147,7 +148,10 @@
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/3.0/howto/static-files/
 
+STATIC_ROOT = os.path.join(BASE_DIR, 'staticfiles')
 STATIC_URL = '/static/'
+STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'
+
 
 # https://django-rest-framework-simplejwt.readthedocs.io/en/latest/settings.html
 SIMPLE_JWT = {

config/settings/production.py

@@ -0,0 +1,36 @@
+from .base import *  # noqa
+from .env_reader import env
+
+DEBUG = env.bool('DJANGO_DEBUG', default=False)
+
+SECRET_KEY = env('DJANGO_SECRET_KEY')
+
+ALLOWED_HOSTS = env.list('DJANGO_ALLOWED_HOSTS', default=[])
+
+# https://docs.djangoproject.com/en/dev/ref/settings/#secure-proxy-ssl-header
+SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")
+# https://docs.djangoproject.com/en/dev/ref/settings/#secure-ssl-redirect
+SECURE_SSL_REDIRECT = env.bool("DJANGO_SECURE_SSL_REDIRECT", default=True)
+# https://docs.djangoproject.com/en/dev/ref/settings/#session-cookie-secure
+SESSION_COOKIE_SECURE = True
+# https://docs.djangoproject.com/en/dev/ref/settings/#csrf-cookie-secure
+CSRF_COOKIE_SECURE = True
+# https://docs.djangoproject.com/en/dev/ref/middleware/#x-content-type-options-nosniff
+SECURE_CONTENT_TYPE_NOSNIFF = env.bool(
+    "DJANGO_SECURE_CONTENT_TYPE_NOSNIFF", default=True
+)
+
+SENTRY_DSN = env('DJANGO_SENTRY_DSN', default='')
+
+if SENTRY_DSN:
+    import sentry_sdk
+    from sentry_sdk.integrations.django import DjangoIntegration
+    from sentry_sdk.integrations.celery import CeleryIntegration
+
+    sentry_sdk.init(
+        dsn=SENTRY_DSN,
+        integrations=[
+            DjangoIntegration(),
+            CeleryIntegration(),
+        ]
+    )

requirements.txt

@@ -1 +1 @@
--r requirements/base.txt
+-r requirements/production.txt

requirements/base.txt

@@ -7,3 +7,5 @@ djangorestframework-simplejwt==4.4.0
 celery==4.4.6
 django-celery-results==1.2.1
 django-celery-beat==2.0.0
+
+whitenoise==5.1.0

requirements/production.txt

@@ -0,0 +1,5 @@
+-r base.txt
+
+whitenoise==5.1.0
+gunicorn==20.0.4
+sentry-sdk==0.16.0

runtime.txt

@@ -0,0 +1 @@
+python-3.7.7