CriteriGuide

Description

The CriteriGuide Single Page Application (SPA) acts as a viewer's guide to track a user's real-world interaction with a must-see selection of the Criterion Film Collection. A user may mark a film as watched and/or favorited as well as add individual viewing notes with an entered time stamp for further study or reference. This backend repo serves as an API database to populate the frontend with what a user actually modifies or creates to give them a unique and seamless experience.

This repo should be used in conjunction with the frontend repo link listed below to fully experience the app's functionality.

Install Instructions

• Fork the repo and copy the SSH link.

• cd into your desired folder and paste the SSH link into your terminal and hit enter.

• Once the repo is opened in your preferred text editor, type bundle install in your terminal, then hit enter to run the installation.

• Once the Ruby gems are installed, type rails s in your terminal to set up a local server.

• Copy the address provided by rails s and paste it into your browser's address bar. (This is often listen in your terminal as "Listening on:")

• Once navigated to the above address, you will be able to view a JSON rendering of the database's information. In order to improve readability, feel free to download and use a JSON viewer Chrome extension like this one here: https://chrome.google.com/webstore/detail/json-viewer/gbmdgpbipfallnflgajpaliibnhdgobh?hl=en-US

Frontend Repo Link

https://github.com/rowemac/CriteriGuide-Front-End

Contributer's Gude

• If you wish to contribute to this repo please submit a pull request or a new issue.

License

• This app is licensed under The MIT License located here: https://github.com/rowemac/CriteriGuide-back-end/blob/master/LICENSE.md

Sources

• https://rubygems.org/
• https://www.vulture.com/article/criterion-channel-best-movies-streaming.html
• https://www.imdb.com/
• https://www.w3schools.com/