This repository contains the code responsible for openstates.org, the website and v2 API (graphql).
Changes should be made in a local checkout of the repo. There is a bit of setup to get a working DB and environment, which by default will run in docker.
- Branch off of the
developbranch - Follow instructions for working on openstates.org from the docs.
- Quirks I ran into:
npm run startdid not actually make JS/CSS available when I hit the app atlocalhost:8000. Instead I rannpm run buildand then rebuilt the docker containers withdocker compose build, finally started them again.- For some reason my DB ended up missing a row representing the Django Site. This resulted in something like "Site
not found" error when trying to log in/register. Solution was:
- Get shell on the running container
sudo docker exec -it openstatesorg-django-1 /bin/bash - In that shell run
poetry run python manage.py shell --settings=web.settings - In THAT shell
run
from django.contrib.sites.models import Site;Site.objects.get_or_create(domain='openstates.org', name='openstates.org') - However for me this created an entry with
SITE_IDof2when1is the necessary value to match up withweb/settings.py
- Get shell on the running container
- Merge your feature branch into
develop(this launches a workflow that publishes docker images) - Merge
developintomain(this gets code into the branch that should be used for deploy)
- Check out the
mainbranch of this repository to your local workstation - You will need permissions on the Open States AWS account to be able to interact with at least the parameter store and the EC2 instance where the site is deployed
- You need the SSH private key to access the EC2 instance, stored at
~/.ssh/openstates-master.pem - Ensure that you have the correct python version installed via pyenv
- Install the aws cli tool
- Install ansible,
such that
ansible-playbookcommand is available. (There are recent changes in the package re:ansible-communitywhich might necessitate a change in our deploy script. For now, I just deployed a somewhat older version via my operating system's package manager) - Install the jq utility
- Whichever python your system is using to execute ansible-playbook needs botocore and boto3 packages installed.
These are used on the system running ansible-playbook to do AWS secret/parameter lookups. Since I installed
ansible via my operating system's package manager, I installed via
sudo apt install python3-boto3 python3-botocore
- Whichever python your system is using to execute ansible-playbook needs botocore and boto3 packages installed.
These are used on the system running ansible-playbook to do AWS secret/parameter lookups. Since I installed
ansible via my operating system's package manager, I installed via
- In your copy of this repo, with
mainchecked out, run the command, which runs a script which runs a set of ansible tasks:
poetry run inv deploy
All the steps should be OK. It's normal to see a lot of output of things changing. You should get to something like the following near the end:
PLAY RECAP ************************************
openstates.org : ok=41 changed=6