diff options
| author | Galen Guyer <galen@galenguyer.com> | 2022-07-28 12:21:13 -0400 |
|---|---|---|
| committer | Galen Guyer <galen@galenguyer.com> | 2022-07-28 12:26:25 -0400 |
| commit | be595a8507b91034347382727e8fdc8be662debe (patch) | |
| tree | 4279c51f6e99403f24ffb5f9beacab4bbf41f325 | |
| parent | 267810a0e61a11a28a7226f201c6b4b2d65c6d2c (diff) | |
document that shit
| -rw-r--r-- | README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9c15208 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# vote +because paper ballots are so 2019 + +Imagine this. You're a somehow still functioning student organization of computer nerds. You've been using paper ballots to vote for the last 40 years. But then, disaster strikes! Global ~~ligma~~ COVID takes over, and if you so much look at a slip of paper, The Virus will take you. Enter vote, a 🚀 blazingly fast 🚀... Wait. This is Go, not Rust. It can't be blazingly fast. Uhh... Enter vote, a reasonably fast voting app with less memory safety than if it was written in Rust. But hey, gotta Pokemon _Go_ to the polls somehow, right? Right...? This is why I'm a software engineer and not a comedian. + +Anyways, now we can vote online. It's cool, I guess? We have things such as: + - **Server-side rendering**. That's right, this site (should) (mostly) work without JavaScript. + - **Server Sent Events** for real-time vote results + - **Limited voting options**. It's worse than Google Forms! (See To-Dos. I hope to change that someday(tm)) + +## Configuration +You'll need to set up these values in your environment. Ask an RTP for OIDC credentials. A docker-compose file is provided for convenience. Otherwise, I trust you to figure it out! +``` +VOTE_HOST=http://localhost:8080 +VOTE_JWT_SECRET= +VOTE_MONGODB_URI= +VOTE_OIDC_ID=vote +VOTE_OIDC_SECRET= +VOTE_STATE= +``` + +## To-Dos +- [ ] Custom vote options +- [ ] Write-in votes +- [ ] Ranked choice voting |