Democracy voucher test implementation

introduction

The civic project that this code implements goes by different names: "Democracy Vouchers" (as implemented by Seattle) or "Democracy Dollars" (as implemented by Oakland). You can read more about it on Wikipedia.

The purpose of this project is to implement a testbed for ideas for the City of Oakland project, with the hope of making something useful for future governments' democracy voucher programs. A primary goal of Oakland's project is to introduce digital vouchers, vis-à-vis Seattle's program, which focused on physical vouchers. Digital vouchers have the promise of making the system cheaper to implement and manage but also introduce new security considerations.

building the application

This software runs as a Docker application, so it requires a Docker Desktop or Docker Engine environment in order to run; this also installs the Docker command-line tool, which is required for building the application's Docker images.

It also requires sbt for running the build scripts. With sbt installed, you can run

sbt dockerBuild

in this directory to build the Docker images.

running the application

The Docker images for the application need to first be built, as above. To run the application see docker/README.md.

The project includes a GitHub Actions workflow that publishes the static site content to GitHub Pages. These pages may not be fully functional without the back-end services, of course, but it provides a quick way to share that part of the system.

developing the application

See doc/Developing.md.