Skip to content

democracyworks/open-civic-data-week-2024

Repository files navigation

open-civic-data-week-2024

About

This demo web application uses the Civic Information API to power a basic voter portal. Users may submit an address and be presented with some information about their representatives.

Installing & running the application

Running this demo with docker compose (recommended) requires installing Docker. To start the app in development mode, run:

make dev

Navigate to localhost:3000 to visit the app.

Alternatively, install Node JS and run the following:

npm install && npm run dev

API Credentials

To vend a Civic Information API key, follow the instructions in the documentation.

To vend a DW API key, reach out to us via our website.

Create an .env file in the root of this directory and add the credentials. See .env.example.

Dependencies

The demo uses Express, HTMX, and Handlebars.

About Democracy Works

Democracy Works is a nonpartisan, nonprofit organization that collaborates with election officials, leading tech platforms, and world-class partners to drive voter access and participation. Learn more at our website.

Relevant links