Thanks to visit codestin.com
Credit goes to github.com

Skip to content

deannahburke/consultancy_the_list_fe

 
 

Repository files navigation

The List

Table of Contents
  1. Project Overview
  2. Built With
  3. Setup
  4. User Walkthrough
  5. API Endpoints
  6. Contributors

Project Overview

Has a friend ever recommended an amazing movie to you, only for you to immediately forget about it? Have you ever read an incredible book you swear someone suggested, but you can't remember who to thank? The List is here to help. Browse thousands of movies and books, personally recommend them to your friends, and store media recommendations made to you all within one convenient user interface!

Visit the app on heroku ⚛️

Check out the corresponding back-end repo 📋

Built With

Version 2.7.4
Version 5.2.8




Setup

To set up the project on your local machine, complete the following steps:

  1. Ensure you have the correct versions of both Ruby(2.7.4 or later) and Rails(5.2.8 or later) by running ruby -v and rails -v from your command line.
  2. Register for free API key here.
  3. Clone the repo: git clone [email protected]:wesatt/consultancy_the_list_fe.git — for SSH
  4. Install gems and dependencies: bundle install
  5. Configure API key by first running bundle exec figaro install in your command line and then configuring your API key in your application.yml file:
movie_api_key: your_key_here
  1. Authentication: Additional information about gem 'omniauth-google-oauth2' can be found here.

User Walkthrough

welcome
The List uses Google Oauth 2.0 to authenticate its users. A new user will be prompted to enter their Gmail account and password in order to access and sign in to The List. Once signed in, the user will land on their dashboard, which displays various media recommendations, by whom they were recommended, and a personal watchlist.

Screen Shot 2022-08-04 at 2 24 40 PM

From the dashboard, a user can navigate to a search page, where they can search for media to add to their watchlist or recommend to other users.

movie search

After searching for either a book or a movie, a user will be able to browse all the results, click the link for that particular media, and see additional information. The user is able to recommend this media to other users from this page.

movie show

API Endpoints

The List consumes several API's, including our own, built from the ground up back-end, TheListAPI. Additionally, The List consumes the following two external API's for media data:

Screen Shot 2022-08-03 at 10 27 13 AM
Documentation here.

Screen Shot 2022-08-03 at 10 52 11 AM
Documentation here.

Contributors

Back-end Team

Eric Espindola Chavez — GithubLinkedIn
Chris Kjolhede — GithubLinkedIn
Becky Nisttahuz — GithubLinkedIn

Front-end Team

Deannah Burke — GithubLinkedIn
Wesley Garcia — GithubLinkedIn
Sai Hall — GithubLinkedIn

Instructor/Project Manager

Jamison Ordway

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 77.7%
  • HTML 20.1%
  • JavaScript 1.3%
  • SCSS 0.9%