Working On openstates.org

openstates.org is the public-facing result of all the work we do. The site is built in Django and includes the web frontend and API.

Checking out

Fork and clone the openstates.org repository:

  • Visit https://github.com/openstates/openstates.org and click the ‘Fork’ button.

  • Clone your fork using your tool of choice or the command line:

    $ git clone git@github.com:yourname/openstates.org.git
    Cloning into 'openstates.org'...
    
  • And remember to install pre-commit:

    $ pre-commit install
    pre-commit installed at .git/hooks/pre-commit
    

Getting a working database

Whether you’re aiming to work on openstates.org or just want to import scraped data, you’ll need postgres server running in your docker environment.

If you haven’t set up docker yet, see Installing docker.

First, make sure that the database is running with:

docker-compose up -d db

Then, to initialize an empty Open States database:

./docker/init-db.sh

If you’re working on scrapers you’ll now find that this database is available to your scrape processes!

Running Tests

You can run the tests for the project via:

./docker/run-tests.sh

You can also append standard pytest arguments such as -x to bail on first failure.

Example of running just the v1 tests, bailing on error:

./docker/run-tests.sh v1 -x

Repository overview

The project is rather large, with quite a few django apps, here’s a quick guide:

Django Apps:

  • bulk/ - handles bulk downloads on the website
  • dashboards/ - dashboards for viewing various statistics
  • geo/ - geography services for legislator lookup
  • graphapi/ - powers GraphQL API
  • profiles/ - user and subscription management
  • public/ - public-facing pages (bulk of the site)
  • utils/ - utilities shared by the other applications
  • v1/ - backwards-compatibility shim implementing much of the old v1 API

Other Stuff:

  • ansible/ - the files used to deploy OpenStates.org are here
  • docker/ - special scripts for running tests, etc. within docker
  • openstates/ - core Django settings files
  • static/ - various static assets, including frontend code
  • templates/ - Django templates

Running openstates.org

Simply running docker-compose up should start django & the database, then browse to http://localhost:8000 and you’ll be looking at your own local copy of openstates.org

Running outside of Docker

It might be desirable to test outside of docker sometimes to bypass caching or other issues that make development within the docker environment difficult. If so, you can install goreman (or any foreman clone) and run goreman start.