Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Best Book Awards #9520

Open
5 of 17 tasks
mekarpeles opened this issue Jul 3, 2024 · 3 comments · May be fixed by #9886
Open
5 of 17 tasks

Best Book Awards #9520

mekarpeles opened this issue Jul 3, 2024 · 3 comments · May be fixed by #9886
Assignees
Labels
Lead: @mekarpeles Issues overseen by Mek (Staff: Program Lead) [managed] Priority: 2 Important, as time permits. [managed] Theme: Book Tags Issues related to community book tags Theme: Reading Log Related to workflows for creating, modifying, displaying a user's reading log. [managed] Type: Feature Request Issue describes a feature or enhancement we'd like to implement. [managed]

Comments

@mekarpeles
Copy link
Member

mekarpeles commented Jul 3, 2024

Feature: Best Books

https://docs.google.com/document/d/1Ddeg-fWWZ0iCFzVtZR0yGY_vCPttIUrd4tCIWwvYj6g/edit#heading=h.hwsgbba3g9bn

A feature called "Best Book Awards", where a patron who has Already Read a book may nominate it as the Best Book on a Topic.

Requirements

  • Formalize the schema for Best Books
  • Core Models for Best Book Nominations
  • JSON API (similar for ratings) for submitting, updating, and deleting nominations
  • Adding 🏆 total counts to the Community Interest Bar
  • Updating the Review Section to include 🏆 counts-per-topic
  • Updating the Already Read Reading Log form to allow Best Book nominations
  • Creating a form for submitting Best Book nominations

Known Bugs

  • Currently, as of Oct 8, 2024, if you submit an award w/o having marked the book as "Already Read", you see a toast error like: "You can award only if you have read the bookNonemekarpeles". (this has been on front-end but not on backend)

Design Feedback

  • The "Comments" section of the bestbook-modal should be larger / resizable (e.g. a textarea?)
  • [ ]

Next Steps

  • Fix pre-commit errors
  • Make it so when you click the awards icon, it pulls up a new modal named bestbook_modal_link (because previously it was observations_modal_link)
    • Add js handlers to respond to bestbook_modal_link for modal toast messages
  • When we submit the form, we need some way to take the data and submit to the backend without refreshing the page → we’re using a click handler on the submit button + fetch POST
  • Add caution message if award is clicked but book is not yet marked as "already read"
  • CSS cleanup: Consolidate + decrease duplicated styles in our less using & nesting and cleaning up classes
  • DRY & Update APIs: Get the awards and count together (needs discussion)
  • Mobile responsiveness & review (needs discussion)

Schema

table best_book_nominations:

  • id serial
  • submitter
  • work_id
  • edition_id (optional)
  • topic (name or Tag key)
  • comment (optional)
  • created
  • updated
@mekarpeles mekarpeles added Type: Feature Request Issue describes a feature or enhancement we'd like to implement. [managed] Theme: Reading Log Related to workflows for creating, modifying, displaying a user's reading log. [managed] Priority: 2 Important, as time permits. [managed] Lead: @mekarpeles Issues overseen by Mek (Staff: Program Lead) [managed] Theme: Book Tags Issues related to community book tags labels Jul 3, 2024
@mekarpeles mekarpeles added this to the Sprint 2024-07 milestone Jul 3, 2024
@mekarpeles
Copy link
Member Author

mekarpeles commented Jul 3, 2024

We may wish to consider (during design call) ideas for merging Star Ratings, Review Tags, and Best Book trophies into the same submit form/component so there aren't so many competing features.

EDIT: It looks like goodreads had a similar idea:
image

@mekarpeles
Copy link
Member Author

@noobCoderVP can I assign you to this one?

@mekarpeles mekarpeles self-assigned this Jul 5, 2024
@noobCoderVP
Copy link
Contributor

noobCoderVP commented Jul 6, 2024

Yes sure

EDIT: @mekarpeles + @noobCoderVP are using this message for Project Managing this issue:

Feature: Best Books

https://docs.google.com/document/d/1Ddeg-fWWZ0iCFzVtZR0yGY_vCPttIUrd4tCIWwvYj6g/edit#heading=h.hwsgbba3g9bn

A feature called "Best Book Awards", where a patron who has Already Read a book may nominate it as the Best Book on a Topic.

Requirements

  • Formalize the schema for Best Books
  • Core Models for Best Book Nominations
  • JSON API (similar for ratings) for submitting, updating, and deleting nominations
  • Adding 🏆 total counts to the Community Interest Bar
  • Updating the Review Section to include 🏆 counts-per-topic
  • Updating the Already Read Reading Log form to allow Best Book nominations
  • Creating a form for submitting Best Book nominations

Test Cases

  • What happens if a patron loads the page, uses JS to mark book as "Already Read" (without refreshing) and then clicks on "award" and tries to submit best book?

Known Bugs

  • Currently, as of Oct 8, 2024, if you submit an award w/o having marked the book as "Already Read", you see a toast error like: "You can award only if you have read the bookNonemekarpeles". (this has been on front-end but not on backend)

Design Feedback

  • The "Comments" section of the bestbook-modal should be larger / resizable (e.g. a textarea?)

Next Steps

  • Fix pre-commit errors
  • Make it so when you click the awards icon, it pulls up a new modal named bestbook_modal_link (because previously it was observations_modal_link)
    • Add js handlers to respond to bestbook_modal_link for modal toast messages
  • When we submit the form, we need some way to take the data and submit to the backend without refreshing the page → we’re using a click handler on the submit button + fetch POST
  • Add caution message if award is clicked but book is not yet marked as "already read"
  • Fix submit logic, close bestbook modal, and open the community review tags form
  • CSS cleanup: Consolidate + decrease duplicated styles in our less using & nesting and cleaning up classes
  • DRY & Update APIs: Get the awards and count together (needs discussion)
  • Mobile responsiveness & review (needs discussion)

Schema

table best_book_nominations:

  • id serial
  • submitter
  • work_id
  • edition_id (optional)
  • topic (name or Tag key)
  • comment (optional)
  • created
  • updated

@github-actions github-actions bot added the Needs: Response Issues which require feedback from lead label Jul 6, 2024
@mekarpeles mekarpeles assigned noobCoderVP and unassigned mekarpeles Jul 8, 2024
@mekarpeles mekarpeles removed the Needs: Response Issues which require feedback from lead label Jul 8, 2024
@mekarpeles mekarpeles linked a pull request Sep 17, 2024 that will close this issue
2 tasks
@mekarpeles mekarpeles modified the milestones: Sprint 2024-09, 2024-11 Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Lead: @mekarpeles Issues overseen by Mek (Staff: Program Lead) [managed] Priority: 2 Important, as time permits. [managed] Theme: Book Tags Issues related to community book tags Theme: Reading Log Related to workflows for creating, modifying, displaying a user's reading log. [managed] Type: Feature Request Issue describes a feature or enhancement we'd like to implement. [managed]
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants