Skip to content
/ rancid Public

An IdeaBox practice that works with a RESTful API to display movies in a user friendly focused way.

Notifications You must be signed in to change notification settings

gaj23/rancid

Repository files navigation

☢️🪥 Radioactive Toothbrushes ☢️🪥


Table of Contents


Introduction

Designed with multi-screen viewing in mind, this is a variation of the project set forth by Turing School of Software and Design. See rubric here.

Users can interact with a selection movies uploaded from a RESTful API by scrolling through images and titles of said movies. They then can click a movie to view further details and either use the back button or the provided home button to navigate to the landing page.

As a team, we decided to polish off our work to create an MVP that meets Iteration 4 requirements. We decided to deploy this site to gh pages as our stretch and reaffirm our knowledge in React, Router, & Cypress-- the three new technologies we learned and utilized in this project.

Features

To view please:

  • please visit here to interact and view
  • has desktop & mobile features

Categories:

Home Page

Upon navigating to our landing page, users see the available movies.

Example of Mobile Experience
all movies

Selecting a Movie

A user can scroll through our movies and select a movie to gain further details on that film.

Example of Mobile Experience
selecting Onward
Example of Desktop Experience Note: hovering abilities exist on desktop & not on mobile.
scrolling through desktop view

Going Back to the Home Page

Once a user is done reading the film's details, they then can click the home icon to return the the landing page.

Example of Mobile Experience
navigating to home
Example of Desktop Experience Note: hovering abilities exist on desktop & not on mobile.
navigating to home on the desktop

Error Message

If a problem with the API or perhaps the user wishes to navigate to a movie by using the url and makes a mistake, an error message will load so the user can become aware that there is a problem.

Example of Mobile Experience
navigating to home

Cypress User Flow Testing

Example of Cypress Experience
testing user flow in cypress

Technologies

  • React
  • Router
  • Cypress for Testing
  • CSS
  • HTML
  • Flat Icon for home icon
  • WAVE for accessibility auditing
  • Lighthouse for accessibility auditing
  • Webpack

Future Iterations

More specifics about future work or refactoring can be found in this projects GH issues, particularly, issue #28.

Discussion about applying SCSS principals occurred at the beginning of our project. However, rather than get ahead of ourselves, we reoriented ourselves to keep the MVP in mind. A future iteration could include SCSS refactoring.

Contributions

Thank you Casey Dallavalle, Justin Corbin, and Leta Keane for your guidance and advice.

To Contribute

If you'd like to contribute to the code, please complete the following steps:

  • clone this repo locally: git clone [email protected]:gaj23/rancid.git <renameHere>
  • API documentation & endpoints are here
  • from there please create a new branch following this pattern: git checkout -b initials/feature-fix/focus-of-branch
  • cd into your local copy and run npm install
  • Have Cypress for testing
  • check that the following key-value pair in scripts is in your package.json
  • "cypress": "cypress open"
  • if not please download Cypress with npm i -D cypress and add the above to scripts.
  • contribute as you'd like and push up your work for review Thank you.

Author

Gabrielle Joyce GH Richard Tyler GH
Ms. Joyce Mr. Tyler

About

An IdeaBox practice that works with a RESTful API to display movies in a user friendly focused way.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published