Themes of the software which you will encounter, and may have questions about.
asm: The Abstract State Machine, introduced by Free and Fair as a tool to aid in formal reasoning about the system, but has development-time tradeoffs.dashboard: In the RLA Software, the term "Dashboard" is overloaded, and both refers to a UI component (the more traditional usage), but also is a reified data structure that contains summary data used throughout the application, loosely associated with the three main UI dashboards in the system.
Guides to the source code can be found below:
ci: Continuous integration support.client: The front-end of the tool, written in TypeScript and making use of React and redux.docker: Dockerfiles for building project components, used heavily by Democracy Works for creating staging and testing environments.script: Scripts that are generally useful for the project. Currently includes a script used to build project releases. The release-building script might be useful to read to understand how the project fits together.server: The back-end of the tool including the API server. This is where the bulk of the code is located.test: End-to-end test scripts, test credentials, and test data.tools: Used by Free and Fair to build documentation, not currently used.
There is still a lot of work to do! If you would like to start improving the software, the next steps document can get you started.
Read over the list of inherited quirks with the way the software and development environment work.
The original documentation for this software is available under the freeandfair directory.