Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 2.24 KB

readme.md

File metadata and controls

49 lines (35 loc) · 2.24 KB
Raw

Stopwatch

Research and action for fair and accountable policing

Staging: https://stopwatch.commonknowledge.dev/

Stack

  • Django (fullstack django app, no js frontend)
  • Bootstrap (css an' stuff)
  • Wagtail (CMS, administration, editor workflows and storage)
  • Webpack (asset pipeline)
  • PostgreSQL (Database & search index)
  • Digital Ocean App Platform (Compute, database hosting, object storage & CDN)

Dev quickstart

Easy mode: VSCode Dev Container

  • Make sure you have Docker, VSCode, and the Remote Development extension installed.
  • Once installed run the command "Clone Repository in Container Volume" in VSCode selecting this repository. This methodology makes for a slightly faster site.
  • Wait for the dev container to build.
  • Check your terminal and respond to any setup prompts it asks for
  • Search for stopwatch/settings/local.py on LastPass and paste its contents into the corresponding local file
  • Use VSCodes' 'run' command (usually aliased to F5) to run the app.
    • Make sure you use the 'App' configuration, which will start both the Djagno app and the frontend Webpack build pipeline.
    • You may need to go to View > Run to look at this configuration.
  • Go to localhost:8000/admin
  • Use the 'import' option on the left to seed the archive with content from the staging site.
  • OR run the setup script to populate some demo pages 
    python manage.py setup_pages --scratch True --ensure-site True --ensure-pages True

Hard mode: Using Dockerfiles

Figure it out for yourself based on the .devcontainer dockerfile and write it up here ;)

Technical documentation

Build process

This repository has a development dockerfile (.devcontainer/Dockerfile) and a production one (./Dockerfile).

They both run .bin in ./.bin to configure their environments and install dependencies:

  • Base container configuration, which is run infrequently (installing apt packages, etc) should be configured in prepare.sh.
  • Frequently-run .bin (installing pip packages, etc) should go in install.sh. The difference between these is that changing prepare.sh triggers a full rebuild of the development container, whereas install.sh is only run after the container is built.
  • build.sh is the last thing run on deploy to production