Code Monkey home page Code Monkey logo

consultancy_the_list_fe's Introduction

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 โ€” Github โ€ข LinkedIn
Chris Kjolhede โ€” Github โ€ข LinkedIn
Becky Nisttahuz โ€” Github โ€ข LinkedIn

Front-end Team

Deannah Burke โ€” Github โ€ข LinkedIn
Wesley Garcia โ€” Github โ€ข LinkedIn
Sai Hall โ€” Github โ€ข LinkedIn

Instructor/Project Manager

Jamison Ordway

consultancy_the_list_fe's People

Contributors

saihall avatar wesatt avatar benistta avatar deannahburke avatar ckjolhede avatar erock02 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.