/movie-slater-fe

front-end files for Movie Knights group project

Primary LanguageHTMLMIT LicenseMIT

Maintainability Test Coverage

Movie Knight

You can find the deployed project at https://movieknight.dev/.

4️⃣ Contributors

Addison Hill Bradley Peterson John Rhee Krunal Patel
Nicolas Janes Ruwaidah Alfakhri Monique Soto Harper Atlas


Project Overview

[Trello] https://trello.com/b/8MvjHQji/labs-20-movie-knight

[Product Canvas] https://www.notion.so/Movie-Knight-2d71feaa483f4843967ca88119a72d03

[UX Design files] https://www.figma.com/file/yxTLXTgvpsFYTDdKmmjjoW/Movie-Slater-Monique-Soto-and-Harper-Atlas?node-id=1206%3A39

The best possible experience for booking movie tickets with assigned seats, as a group, or solo when the constraints of seeing a movie are variable.

Problem:

  • Choosing a movie time and theater for a group of friends to see a movie is broken and unintuitive.
  • All movie booking interfaces assume you already know what time, which theater, and which movie you want to go see, and that's entirely not the case.

Mission: To make booking movie tickets brainless and fast. To be able to know what, where and when the group of you could go to a movie and maybe even be able to sit together.

4️⃣ Key Features

  • displays movies showing in theaters within the zip code you've search for
  • provides more detailed information about each movie if required
  • allows users to select their preferences for a movie going experience
  • filters available movies that match those preferences for the user

1️⃣ Tech Stack

Front end built using:

React

Why did you choose this framework?

  • Familiarity
  • Functional components are a simple way to reuse code
  • Client Side Routing with React-Router

Front end deployed to AWS Amplify

[Back end]https://github.com/Lambda-School-Labs/movie-slater-be built using:

Node.js and Express

  • Express provides a simple framework for build API routes
  • KnexJS allows us to write queries with JavaScript
  • MVC model

APIs

2️⃣ OAuth

We used OAuth to allow users to log in via Google as a more seamless user experience.

3️⃣ Gracenote Movie API (tmsapi)

This API gives us our data on current movies showing in theatres by querying by zip code. It returns a list of all movies playing in theaters that match that zip code. In addition it is where our images for movie posters comes from.

3️⃣ Open Movie Database

This API gives us most of our detailed information about each movie such as cast lists, maturity ratings, reviews, run time, etc.

3️⃣ 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:

4️⃣ Testing

We used Jest and React-Testing-Library to test our front end code.

4️⃣ Installation Instructions

After cloning, CD into movie-knight, run "npm install", then "npm start" to open a live server of the react app.

Other Scripts

"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject",
"coverage": "CI=true yarn test --coverage || true"

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.