diff --git a/README.md b/README.md index 2f08657..c08f11e 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,28 @@ # Sixfold Voting Website (`app.sixfold.org`) -This repository contains the code for `app.sixfold.org`, the domain used for Sixfold's quarterly competitions. +This repository contains the code for `app.sixfold.org`, the domain used for Sixfold's quarterly competitions. It has been rewritten from the ground up; the previous codebase was only used as a reference for decoding various magic numbers and determining expected functionality. ## Task List -Here are planned updates to the code, in no particular order: +### High Priority + +- Implement the manuscript assignment algorithm +- Implement the voting process +- Add more feedback to data entry, particularly upon success +- Migrate all timestamps to ISO 8601/RFC 3339 (1970-01-01T00:00:00Z) +- Build a [Bubble Tea](https://github.com/charmbracelet/bubbletea) terminal user interface (TUI) for site administration (as a separate repository) + +## Medium Priority - Migrate from one SQLite database to a per-account database model - Create database schema files -- Migrate all timestamps to ISO 8601 -- Determine why PayPal transaction IDs are sometimes not processed when uploading submissions -- Implement the manuscript assignment process -- Implement the voting process - Allow participants to upload a photo and add links to their profile - Move avatars to database BLOB storage - Allow participants to download their data -- General code style or pattern cleanup +- Improve code quality and markup semantics (enums, classes, XML data) + +## Lowest Priority + - Implement pooling so the testing domain can live on the same server as the production site - Refine PHP configuration -- Add a command-line interface for administration (maybe as its own repository) -- Add more content to this README -- Add more feedback to successful form submissions +- Rewrite this README as a deployment and usage guide