Coder Social home page Coder Social logo

groa-fe's Introduction

You can check out the live demo of Gróa here.

Code Climate

MIT React Typescript code style: prettier Maintainability Test Coverage

more info on using badges here

Contributors

Labs 21

Brianna Keune Benjamin Solt Mariela Gonzales
Billy Gingrich TJ Katalenas Cody M Russell

Labs 23

Mike Sinnema Juana Villalpando Steven Matos Luis Pepen

Project Overview

Trello Board

Product Canvas

UX Design files

Gróa will use our Discovery Engine to present movies suited to your taste based upon the way in which you talk about movies.

Key Features

  • Uploading Letterboxd ZIP file
  • Receiving movie recommendations from Letterboxd data
  • Rating movies
  • Receiving new more fine tuned recommendations based on what you've recently rated.
  • Adding movies to your watchlist

Tech Stack

Front end built using:

React

  • Facebook maintains and continues to improve this framework.
  • 99% backwards compatibility compared to Vues's 90%.
  • In consideration of who will most likely work on Groa in the future, we thought React would be easy to jump in the code base.

Libraries and Packages

axios

  • for easier to read responses than fetch

@fortawesome/fontawesome-svg-core | @fortawesome/free-regular-svg-icons | @fortawesome/free-solid-svg-icons | @fortawesome/react-fontawesome

  • for all fontawesome icons

@material-ui/core | @material-ui/icons | @material-ui/lab |

  • for the stars on movie cards and form inputs

@node-sass

  • drier styling

react-ga

  • google analytics

react-loading

  • for loading screen animation

react-redux | redux-logger | redux-thunk

  • for global statemangement

Front end deployed to AWS Amplify

Back end built using:

Express

  • Accessible documentation
  • Good error handling
  • Faster to implement than vanilla Node.js

Libraries and Packages

apidoc

  • to create easy to read API docs with inline comments

axios

  • for easier to read responses than fetch

cors

  • allows us to configure to avoid cors issues

body-parser | csv-parser | express-fileupload | unzipper

  • to handle uploaded file information

dotenv

  • allows node to read our .env files

standard

pg

pg-format

nodemon

Back end deployed to AWS Elastic Beanstalk

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

REACT_APP_ANALYTICS_ID - this is your Google analytics key, which can be generated in the Google Analytics Console.
REACT_APP_TMDB_API_KEY - this is your API key from TMDb it sources the movie posters we user.

Content Licenses

Image Filename Source / Creator License
imdb-logo.svg unbekanntAmazon.com, Inc. Creative Commons
letterboxd-logo.svg Matthewbuchanan Creative Commons
success_5.svg ------------- Creative Commons
Groa-logo-B2AA.png ------------- Creative Commons

Testing

Client Testing Libraries

Jest

React Testing Library

history

redux-mock-store

API Testing Libraries

Jest

@types/jest

cross-env

supertest

knex-cleaner

knex

Installation Instructions

Clone this repo to your local machine.

Run npm i

Other Scripts

* build - creates a build of the application
* start - starts the production server after a build is created
* test - runs tests in **tests** directory \* eject - copy the configuration files and dependencies into the project so you have full control over them

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

  • Check first to see if your issue has already been reported.
  • Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
  • Create a live example of the problem.
  • Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
  • Ensure that your code conforms to our existing code conventions and test coverage.
  • Include the relevant issue number, if applicable.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.

groa-fe's People

Contributors

azatecas avatar bensolt avatar bgingrich avatar briannakeune avatar cmruss avatar dani-digital avatar jvillalp avatar marielapg avatar moviedatascience avatar msinnema33 avatar robomantis19 avatar steven-matos avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

groa-fe's Issues

Trailer Preview in Movie Card is cut off on Mobile

Expected Behavior

Trailer Preview image should fit inside of the movie card when on mobile.

Current Behavior

Half of the trailer image is being cut off.

Possible Solution

Expanding the size of the card to be full screen will help, while also adjusting the parameters of the video embedding.

Steps to Reproduce

  1. Navigate to groa.us/explore (on mobile)
  2. Select a movie to open the card.
  3. Observe the trailer being cut off.

Context (Environment)

This exclusively happens on mobile devices. On desktop the trailer displays fully. Additionally, the trailer is not cut off when you turn the mobile device horizontally.

Hamburger Menu doesn't collapse when you click on the page

Expected Behavior

When the user clicks on the page (outside of the menu) the menu should collapse.

Current Behavior

The menu stays exposed until the user selects the "in" arrow at the top of the menu.

Possible Solution

Not sure.

Steps to Reproduce

  1. Navigate to https://www.groa.us/explore
  2. Expand the hamburger menu.
  3. Click on the page outside the hamburger menu
  4. Observer the menu remains expanded.

Context (Environment)

The menu that appears when you click the User icon on the right side of the page does disappear when you click anywhere else on the page.

navigation bar on mobile wider than screen,

Expected Behavior

when accessing the recommendation the content should fin into the width of the screen

Current Behavior

navscroll

when accessing the recommendations page, the navigation bar is too wide and overflows

Possible Solution

make the title of recommendation page smaller with a width, 100% the width of the screen on mobile

Steps to Reproduce

  1. Navigate to dashboard on mobile
  2. scroll to the right on mobile and you will see a huge gap
  3. Observer the user is able to scroll horizontally when that isnt a feature

Context (Environment)

mobile view on my xiaomi a2 lite screen

Not able to rate movies in ratings page

Expected Behavior

should be able to re-rate movies in the rating page

Current Behavior

unable to re-rate movies in the rating page

Possible Solution

look into what is being passed into the movie card in ratings page

Steps to Reproduce

  1. Navigate to ratings page
  2. rate a movie that is rated.
  3. Click on the refresh page
  4. Observer the movie has not been updated.

Context (Environment)

all environments

Login appears broken from Chrome

Login appears broken from chrome
image

i attempted other browsers but unable to login
when hitting "Login with Email" i am redirected to the Okta Login Widget
then Im redirected back to Groa.us, however i am not authenticated
login fails even though UserId is available in state

Rating by stars error when blank

Expected Behavior

When you click on your ratings you should see them broken down by the star rating you gave them.

Current Behavior

When you haven't rated a certain star level (i.e. 4.5, 2.5, 2,1 ...) instead of just showing none, it gives you the loading spinner.

Possible Solution

[If you have a hunch about what could fix the problem put it here]

Steps to Reproduce

  1. Navigate to [Ratings]
  2. Observer the [loading spinner for ratings categories that you have blank].

Context (Environment)

[For sure present on Edge, Brave, Chrome, and Safari]

Scrolling on Movie Cards only functions when hovering ratings or trailer (Only FireFox)

Expected Behavior

User should be able to scroll down the movie card regardless of where they hover.

Current Behavior

User can only scroll down when hovering over the trailer or star ratings.

Possible Solution

Honestly no idea since it works on mobile. Maybe adding a screen break and changing the config based on screen size?

Context (Environment)

Mobile scroll for movie cards is fully functional. This issue only occurs on Desktop, and only in firefox.

Multiple movies deleted at one time

Expected Behavior

One movie is supposed to be deleted at a time.

Current Behavior

Two movies are deleted when there are two movies left in a row.

Possible Solution

Not sure as the console.log only shows one movie being sent.

Steps to Reproduce

  1. Navigate to the rating page
  2. go to a row that has only two movies
  3. Click on the remove rating button
  4. Observer the that two movies are removed.

Context (Environment)

this issue happens across the board on all devices.

onboarding start screen is not mobile friendly

Expected Behavior

when the user is new, and accessing it on mobile the on-boarding start screen displays with instructions to the user. the text should take the width of the screen

Current Behavior

the text of the instructions only take 50% of the screen width and to the left on mobile screen

Possible Solution

make the text container width 100% on mobile

Steps to Reproduce

  1. navigate to user_id/onboardingplatform on mobile
  2. Observer the text taking 50% of screen width on mobile

Context (Environment)

mobile phone only
halftext

Change Text on Service Providers button

Expected Behavior

Service Providers button should be "Where to Watch"

Current Behavior

Button displays Service Providers text.

Possible Solution

Change the text.

Movie Card Spacing Inconsistent Across Screen Size

Expected Behavior

Spacing of cards across screen sizes should remain consistent. The size of the posters should expand or contract to match the size of the screen.

Current Behavior

The spacing on my secondary screen is great, but when I have the site open on my primary screen the cards are far too spaced apart.

Possible Solution

Adjust the behavior of the posters to adjust the size of the image rather than adjusting the size of the spacing around the image.

Steps to Reproduce

  1. Open recommendations page on one size screen.
  2. Open recommendations page on another size screen.
  3. Observe difference.

Context (Environment)

On my mobile device (iPhone XR) the padding size is also way too much.

Posters don't Load on Recommended/Ratings/Watchlist Pages

Expected Behavior

Posters should populate for each movie on Recommended, Ratings, and Watchlist pages.

Current Behavior

A placeholder image is loaded instead of the poster images.

Possible Solution

Possibly due to pulls from the old DB.

More likely due to calling the structure of the tables in the Old DB, but querying the new DB, since this issue started before the old DB was turned off.

Steps to Reproduce

  1. Navigate to https://www.groa.us/ratings
  2. Observe no posters

Context (Environment)

Can't confirm currently due to login page non-functional.

Very long movie titles break our card formatting

Expected Behavior

Movie titles should not move the rating and add to watchlist buttons out of the movie card.

Current Behavior

Movie titles move the rating and add to watchlist buttons out of the movie card.

Possible Solution

Either truncate the movie title or constrict the percentage of the card it can occupy.

Steps to Reproduce

  1. Navigate to https://www.groa.us/explore
  2. Search for "Can Heironymus Merkin Ever Forget Mercy Humppe and Find True Happiness?"
  3. Observe formatting cuts off bottom of movie card.

Context (Environment)

Not sure what the best approach is.
longmovietitles

Movie Cards do not fill screen on mobile

Expected Behavior

The movie card should fill the screen on mobile devices.

Current Behavior

There is padding on the left and right of the movie card.

Possible Solution

Remove padding around movie card for mobile.

Steps to Reproduce

  1. Navigate to groa.us/explore (on mobile)
  2. Select a movie poster to open the movie card.
  3. Observe the padding to the right and left of the movie card.

Context (Environment)

This issue primarily hinders the ability of the movie trailers to preview entirely within the movie card on mobile. On desktop we don't want the movie card to take up the entire screen.

Description Missing from Movie Cards on Recommendations Page

Expected Behavior

Movie cards should have the description listed.

Current Behavior

Movie description is missing from the card on recommendations page.

Possible Solution

Have the movie card fetch the information from the API call and display that.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.