VxSuite

The core of the VotingWorks paper-ballot voting system.

About

Includes software for:

• VxAdmin — An offline central election manager laptop
• VxCentralScan — A central scanner for batch scanning of ballots, often used for absentee ballot processing
• VxMark — A traditional ballot-marking device (BMD)
• VxMarkScan — A BMD that also supports limited-dexterity casting; VxMark supports limited-dexterity marking but not limited-dexterity casting
• VxScan — A precinct scanner for casting of ballots (marked by hand or by BMD)
• VxPollBook — An electronic poll book application for checking in voters
• VxHub — An application for designing ballots
• VxPrint — An application for printing ballots

VxAdmin and VxCentralScan comprise the "central system." VxMark/VxMarkScan and VxScan comprise the "precinct system."

VxPollBook, while also deployed in precincts, is certified and acquired separately.

VxHub exists separate from the other apps and is managed by VotingWorks rather than deployed on hardware into locales.

See https://voting.works for more information about VotingWorks.

Development

See the developer documentation, and docs/turborepo.md for building, testing, and caching with Turborepo.

View our contribution guidelines here.

Running with kiosk-browser

It's often helpful and even necessary to run VxSuite via kiosk-browser. The steps for doing so are as follows:

1. Clone kiosk-browser adjacent to this repo.
2. Follow kiosk-browser's build and installation instructions.
3. Clone vxsuite-complete-system adjacent to this repo.
4. Run KIOSK_BROWSER_ALLOW_DEVTOOLS=true ./run-scripts/run-kiosk-browser.sh from vxsuite-complete-system.

License

All files are licensed under GNU GPL v3.0 only. Refer to the license file for more information.