trotFunky/FabulaVotes
1
0
Fork 0
Code Releases Packages Activity
FabulaVotes/README.md

39 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

v1.0: First production version This first version allows login of pre-existing users, creation and update of truths by admins, vote on the truths by users, their display as well as a simple graph for the vote results. Everything persisting in a SQLite database.
2024-07-23 21:51:42 +01:00
# Fabula Votes
This web application is intended as a simple way to share Truths for an upcoming campaign of [Fabula Ultima](https://need.games/fabula-ultima/),
vote and who we think wrote them and see some stats !
# TODO
A list of things that could be implemented/added to the application, some of them are needed for "feature completeness" !
week: Create new weeks and change active one Implement a way for admins to introduce new weeks and set them as the last active one. The last active week is the last one that is accessible to players, and will also prevent the graph from being displayed. Implement arrows for navigating between the weeks in the HTML.
2024-07-26 00:50:38 +01:00
- [x] Being able to change from one week to the next
- [x] Create new weeks for the admin
Redirects: properly redirect to the current week Previously, most redirects targeted the root of the application. This was okay for the first part of development where only one week would be active, but would be annoying when using multiple weeks. Change those redirects to call week::week. Change the login path to be dependant on the current week as well, so it can be correctly redirected.
2024-07-26 01:08:30 +01:00
- [x] Proper week redirection
vote: Change graph display condition, don't fetch for admin Now, the graph will only show when everyone has voted and the week is no longer the last one active. This is to minimize information gathering by looking during voting. Don't fetch the vote data for the admin : it is not used, so no need to query the database. Update README with new TODOs and clean up main includes a bit.
2024-07-26 00:45:53 +01:00
- [ ] Correctly handle non-existing week number
README: Update todo, fix typo
2024-07-23 22:14:18 +01:00
- [x] Add introduction to the weekly truths
v1.0: First production version This first version allows login of pre-existing users, creation and update of truths by admins, vote on the truths by users, their display as well as a simple graph for the vote results. Everything persisting in a SQLite database.
2024-07-23 21:51:42 +01:00
- [ ] Bundle static assets in the binary
README: Update todo, fix typo
2024-07-23 22:14:18 +01:00
- [ ] Move the database queries to their own functions
v1.0: First production version This first version allows login of pre-existing users, creation and update of truths by admins, vote on the truths by users, their display as well as a simple graph for the vote results. Everything persisting in a SQLite database.
2024-07-23 21:51:42 +01:00
- [ ] Cache those results
- [ ] Centralize Markdown parsing ?
Rocket: Use fairings for routes of sub-files Instead of adding all routes manually in the Launch function for Rocket, implement fairings for all the different files that adds the routing to the rocket in a self-contained manner.
2024-07-27 21:22:34 +01:00
- [x] Use fairings for the different elements
vote: Change graph display condition, don't fetch for admin Now, the graph will only show when everyone has voted and the week is no longer the last one active. This is to minimize information gathering by looking during voting. Don't fetch the vote data for the admin : it is not used, so no need to query the database. Update README with new TODOs and clean up main includes a bit.
2024-07-26 00:45:53 +01:00
- [ ] Use guards for User calls ?
Rocket: Use fairings for routes of sub-files Instead of adding all routes manually in the Launch function for Rocket, implement fairings for all the different files that adds the routing to the rocket in a self-contained manner.
2024-07-27 21:22:34 +01:00
- [ ] Use SQLite Row ID for User IDs rather than regular IDs, for randomness ?
auth: Split off vote data from the user Now that the application is going to have multiple pages, vote data makes no sense to keep with the user. The user struct will be used everywhere to check for authentication, which is not the case for previous votes. Create a new struct and function in src/vote.rs to retrieve existing votes and use them in places where user.votes was used previously. Remove vote-related code from src/auth.rs and the week number dependence that it required.
2024-07-28 14:36:52 +01:00
- [x] Split user from vote data
v1.0: First production version This first version allows login of pre-existing users, creation and update of truths by admins, vote on the truths by users, their display as well as a simple graph for the vote results. Everything persisting in a SQLite database.
2024-07-23 21:51:42 +01:00
# Dependencies
README: Add forgotten frontend dependency I only added the Rust dependencies to the README, but we do have one for the Javascript run in the frontend. Add Chart.js to the README.
2024-07-30 23:34:17 +01:00
This project currently uses, for the backend :
v1.0: First production version This first version allows login of pre-existing users, creation and update of truths by admins, vote on the truths by users, their display as well as a simple graph for the vote results. Everything persisting in a SQLite database.
2024-07-23 21:51:42 +01:00
- [Rocket](https://docs.rs/rocket/0.5.1/rocket/), for the web application backend
- [SQLX](https://docs.rs/sqlx/0.7.4/sqlx/), for database access (this is only expeceted to be used with SQLite)
- [Tera](https://docs.rs/tera/latest/tera/), for templating
- [Argon2](https://docs.rs/argon2/latest/argon2/), for password hashing
- [Pull_down CMark](https://docs.rs/pulldown-cmark/0.11.0/pulldown_cmark/), for markdown rendering
README: Add forgotten frontend dependency I only added the Rust dependencies to the README, but we do have one for the Javascript run in the frontend. Add Chart.js to the README.
2024-07-30 23:34:17 +01:00
For the frontend :
- [Chart.js](https://www.chartjs.org/), for rendering the vote graph.
v1.0: First production version This first version allows login of pre-existing users, creation and update of truths by admins, vote on the truths by users, their display as well as a simple graph for the vote results. Everything persisting in a SQLite database.
2024-07-23 21:51:42 +01:00
# License
The code present in this repository is licensed under the Mozilla Public License 2.0.
Copy permalink