/MovieMaze

Mod 4 - Solo Project - uses a custom API to present movie information & where the movie is streaming

Primary LanguageJavaScript

MovieMaze

MovieMaze is an app to to look up a movie, see it's information, and see what streaming services it's available on.

Check it in action!

Setup

  1. Fork or clone this repo: git clone git@github.com:Kate-v2/MovieMaze.git <name of your choice>
  2. Install Dependencies: npm install
  3. Update Libraries npm audit fix
  4. Build Application: npm run build
  5. To see the app in action locally: npm start then go to: http://localhost:8080/

APIs, Data, Services

This app obtains data through:

How to Use

  1. Go to MovieMaze
  2. User the search bar to look up a title
  3. Pick the title you want
  4. View movie/series details

Known Issues

Running Tests

To run tests use npm test

Screenshots

Future Goals

  • Incorporate user suggestions
  • Incorporate suggestions on each movie page - TasteDive API
  • Add a watched button
  • Data Visualization for watched this month & watched vs liked

How to Contribute

To contribute, see the setup instructions.

  • Open Issues
  • Create a new branch describing the feature. If you close an issue, include it's number in the branch name.
  • Please describe all changes in the Pull Request (to Master), and all relative issue cards/actions.
  • Please use the Pull Request Template as the baseline for communication - feel free to add more!
  • Please update the README if anything is affected.

Core Unfinished Features

Core Contributors

Technical

Turing Project Details:

GitHub Pages Setup

This site will be served from GitHub Pages in production.

In order to see your application running on production:

  1. From the command line, run npm run build.

  2. Commit and push your application to GitHub.

  3. Visit your repository on Github

  4. Go to Settings

  5. Under the Github Pages section of Options, select 'master' as your source and click Save

Be sure to npm run build and commit before each push to master. A few seconds after you push up, you should be able to see your application at https://your-github-username.github.io/project-name.