Giter Club home page Giter Club logo

viewing_party's Introduction

Viewing Party

This is a project for Turing Mod3 back-end completed in 10 days. Rails based program to search for movies and invite friends to viewing parties for those movies. We search for movies using the IMDB API and provide review and cast information in addition to basic movie data.

Local Setup

  1. Fork and Clone the repo
  2. Install gem packages: bundle install
  3. Setup the database: rails db:create
  4. Migrate the database: rails db:migrate
  5. Get an API key from imdb.com
  6. Add your API key to the .env folder assigned to the IMDB_API variable! Screen Shot 2021-07-13 at 9 33 38 AM
  7. Run rails s and open localhost:3000 in your browser!

USING THE APP

  • Create an account:
    • From the welcome page, /, click on 'Register New Account'.
    • Enter your email address and a password.
    • Click on the 'Register' button
  • Adding Friends:
    • From the /dashboard look above the 'Your Friends' Banner
    • Enter the email of a friend who already has an account in the 'Your Friends Email' field
    • Click on the 'Add Friend' button.
  • Searching for Moives:
    • From the /dashboard click on 'Discover Top 40 Movies'
      • This will show you the current 40 most popular movies.
    • At the top of the page enter a complete or partial movie title in the 'Search by Title' field.
    • Click 'Find Top Rated Movies' to display the top 40 movies containing your search terms.
  • Creating a Viewing Party

Versions

  • Ruby 2.7.2

  • Rails 5.2.5

viewing_party's People

Contributors

lawrencewhalen avatar aphilosopher30 avatar iandouglas avatar dionew1 avatar megstang avatar timomitchel avatar

viewing_party's Issues

Dashboard: Friends

As an authenticated user,
I see a section for friends,
In this section, there should be a text field to enter a friend's email and a button to "Add Friend"

Scenarios:

  1. If I have not added any friends there should be a message. "You currently have no friends".

  2. If I have added friends, I should see a list of all my friends.

Details: Users should be able to add a friend by their email address, as long as, the friend is a user of our application and exists in our database.

Example:
Bugs Bunny and Lola Bunny are users of our application, but Daffy Duck is not.

  1. When Bugs Bunny enters [email protected] to add friend it will be successful and Lola should show up as Bugs Bunny's friend.
  2. When Bugs Bunny enters [email protected] to add friend it should give an error message that the user does not exist.

Tips: You'll want to research self-referential has_many through. Here is a good starting point to understand the concept. You will probably need to do more googling but that's part of the fun ;)

  • Write a happy path test
  • Write a sad path test

Movies Page

As an authenticated user,
When I visit the movies page,
I should see the 40 results from my search,
I should also see the "Find Top Rated Movies" button and the Find Movies form at the top of the page.

Details: The results from the search should appear on this page, and there should only be a maximum of 40 results. The following details should be listed for each movie.

  • Title (As a Link to the Movie Details page)
  • Vote Average of the movie

New Viewing Party Page

As an authenticated user,
When I visit the new viewing party page,
I should see the name of the movie title rendered above a form with the following fields:

  • Duration of Party with a default value of movie runtime in minutes; a viewing party should NOT be created if set to a value less than the duration of the movie
  • When: field to select date
  • Start Time: field to select time
  • Checkboxes next to each friend (if user has friends)
  • Button to create a party

Details When the party is created, the authenticated user should be redirected back to the dashboard where the new event is shown. The event should also be seen by any friends that were invited when they log in.

Registration Page

When a user visits the '/registration' path they should see a form to register.
The form should include:

  • Email
  • Password
  • Password Confirmation
  • Register Button

Once the user registers they should be logged in and redirected to the dashboard page

Welcome Page

When a user visits the root path they should be on the welcome page which includes:

  • Welcome message
  • Brief description of the application
  • Button to Log in
  • Link to Registration

Details: Implement basic auth in the application allowing a user to log in with an email and password. The password should be stored in the database using bcrypt.

Dashboard: Viewing Parties

As an authenticated user,
I should see the viewing parties I have been invited to with the following details:

  • Movie Title, which links to the movie show page
  • Date and Time of Event
  • who is hosting the event
  • list of friends invited, with my name in bold

I should also see the viewing parties that I have created with the following details:

  • Movie Title, which links to the movie show page
  • Date and Time of Event
  • That I am the host of the party
  • List of friends invited to the viewing party

Dashboard

As an authenticated user,
When I visit '/dashboard'
I should see:

  • 'Welcome <username>!' at the top of page
  • #9 A button to Discover Movies
  • #10 A friends section
  • #11 A viewing parties section

RuboCop

You will use RuboCop to enforce style guidelines. The evaluation rubric at the end project will use it to measure code quality.

RuboCop will be installed when you bundle install. Simply run bundle exec rubocop from the command line to see if there are any violations. Run RuboCop throughout the project to pick up on style violations as you go. DO NOT wait until the end to fix a giant pile of RuboCop errors.

As you work through the project, you may find some of the RuboCop complaints difficult to decipher. Reference the RuboCop documentation and the RuboCop Rails documentation for more information.

Please reach out to your instructors if you find any style violations that you believe should not be enforced. Ask your instructors before editing .rubocop.yml

Dashboard: Discover Movies

As a authenticated user,
When I click on the "Discover Movies" button,
I am redirected to a discover page.

Discover Page

As an authenticated user,
When I visit the '/discover' path
I should see

  • Button to Discover top 40 movies

Details When the user clicks on the top 40 button they should be taken to the movies page.

  • A text field to enter keyword(s) to search by movie title
  • A Button to Search by Movie Title

Details When the user clicks on the Search button they should be taken to the movies page

The movies will be retrieved by consuming The MovieDB API

Continuous Integration with Travis CI

Go to https://travis-ci.com/ and set up your account.

Add the project to your repositories. You can do this from the main dashboard page by clicking the plus button next to My Repositories

Configure your API keys that are environment variables for the travis environment. You can find configuration for environment variables by selecting your repository from the Travis dashboard and clicking More Options -> Settings.

Configure deployment to Heroku by filling in the api_key and app variables in the .travis.yml file.

You can test that your Travis set up is working by pushing a commit to your repository. You should see a build triggered by the Travis dashboard. When the build is complete, you should see the change automatically deployed to Heroku.

Movie Details Page

As an authenticated user,
When I visit the movie's detail page,
I should see

  • Button to create a viewing party

Details This button should take the authenticated user to the new event page

And I should see the following information about the movie:

  • Movie Title
  • Vote Average of the movie
  • Runtime in hours & minutes
  • Genere(s) associated to movie
  • Summary description
  • List the first 10 cast members (characters&actress/actors)
  • Count of total reviews
  • Each review's author and information

Details: This information should come from 3 different endpoints from The Movie DB API

Deploy to Heroku

In addition to the normal deployment, you will also need to set up any API keys manually for your Heroku production environment.

Write Front-End JavaScript

Explore front end JavaScript within your Rails application.

Currently, whenever we click "Find Top Rated Movies" or "Find Movies" the user is redirected to a new page. Implement JavaScript so that instead of redirecting to a new page the results will be displayed on the current page without refreshing.

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.