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

Video Recommendation Page #100

Closed
lfaucon opened this issue Aug 29, 2021 · 0 comments
Closed

Video Recommendation Page #100

lfaucon opened this issue Aug 29, 2021 · 0 comments

Comments

@lfaucon
Copy link
Member

lfaucon commented Aug 29, 2021

Context:
One of the most important piece of Tournesol is its video recommendation page. Tournesol's API returns lists of video sorted by the multiple rating criterias.

The page would have principally two components: 1. The list of video using Tournesol's VideoCard component; 2. The collapsible configuration panel allowing to configure the search preference.

Notes:

  • The video recommendation API endpoint is still a work in progress (tournesol-backend PR 36). Most of the work on this ticket should be first done without it, probably with a a mock like:
const getRecommendationsFromAPI = (searchOptions) => {
    // TODO use API endpoint instead
    return [
        { ...video_1_metadata },
        { ...video_2_metadata },
        { ...video_3_metadata },
    ]
}

we will only afterwards replace the mock function with the proper API call once it is available

  • Visual guide for these components can be found on Figma. ⚠️ The search configurations on the Figma mockup are not exactly what we want. For this first iteration, I would recommend only using date and language.

  • The same Slider components can be used as the one from my current work-in-progress branch: reboot-patch-comparisons

Screenshots:

Configuration collapsed:
Screenshot 2021-08-29 at 16 35 39

Configuration extended:
Screenshot 2021-08-29 at 16 35 30

Details:

  • A new component for the recommendation configuration. It can be collapsed (best using Material-UI Collapse).
  • A new component for a list of video cards receiving the list of video metadata as props
  • A new page at the url /recommendations/ that displays the configuration and the recommendation list and also handles the API connection logic (see notes above)
  • The /recommendations/ url can also be used with GET parameters to configure the API call (for example: /recommendations/?search=Vaccines&date=...&reliability=100)
  • Using the search bar in the top bar brings to the page /recommendations/?search={USER_INPUT}
@lfaucon lfaucon added this to Ready and selected for dev in main-project-board Aug 29, 2021
@sandre35 sandre35 moved this from Ready and selected for dev to In progress in main-project-board Aug 31, 2021
@sandre35 sandre35 moved this from In progress to Under review in main-project-board Sep 11, 2021
@lfaucon lfaucon moved this from Under review to Done in main-project-board Sep 12, 2021
@lfaucon lfaucon closed this as completed Sep 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

2 participants