Code Monkey home page Code Monkey logo

roseflix's Introduction

Roseflix: A Netflix Clone

Roseflix Screenshot

My React.js implementation of Netflix. Movie data was pulled from TMDB and trailer videos from Youtube.

View Video Demo »

Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Contact

About The Project

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Install latest version of npm

  • npm
    npm install npm@latest -g

Installation

  1. Clone the project
    git clone https://github.com/crookedfingerworks/roseflix.git
  2. Go to project directory and Install NPM packages
    npm install
  3. Create .env file
  4. Request an API key from TMDB and add it to your .env
    REACT_APP_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  5. In a new directory, clone the backend and follow installation instructions on its README
    git clone https://github.com/crookedfingerworks/roseflix-backend
  6. You should now have the server running locally. Add the url to your .env
    REACT_APP_SERVER_URL=http://localhost:8080
  7. Start the application
    npm start

Usage

Creating an Account

  1. Go to Sign Up page.
    • From the homepage, enter your email and click 'Get Started'.
    • From Sign In page, click the 'Sign up now' link below 'Sign In' button.
  2. Input the necessary fields. Don't worry. It won't take long.
    • Both email and phone number has to be unique.
    • Display name will be used to autogenerate initial user profile.
  3. You'll be redirected to the login page. Enter your newly created credentials.

Logging In

  1. Go to Sign In page.
    • From the homepage, click 'Sign in' button.
    • From Sign Up page, click the 'Sign in now' link below 'Sign Up' button.
  2. Input the necessary fields and proceed.
    • You can sign in using either email or phone number.

Searching for a Show

  1. Log in and select a profile.
  2. Click the appropriate tab for your search.
    • If searching for a movie, click 'Movies' tab in the header.
    • If searching for a series, click 'TV Shows' tab in the header.
  3. Click the search icon on the header.
  4. Input your search term and press enter.
  5. To show all shows again, clear the search input and press enter.

Adding User Profile

  1. Log in to your account.
  2. Click 'Manage Profiles'.
  3. Click 'Add Profile'.
    • You can only add up to 5 profiles for each account.
  4. Click the pencil/edit icon and choose your preferred avatar.
  5. Enter your preferred display name and click 'Save'.
    • You can't use avatars and names already used by other profiles in the same account.

Editing User Profile

  1. Log in to your account.
  2. Click 'Manage Profiles'.
  3. Click the profile you wish to edit.
  4. Modify the profile as you see fit and click 'Save'.

Deleting User Profile

  1. Log in to your account.
  2. Click 'Manage Profiles'.
  3. Click the profile you wish to delete.
  4. Click 'Delete Profile'.
  5. Confirm deletion by clicking 'Yes'.

Contact

[email protected]

Project Link: https://github.com/crookedfingerworks/roseflix

roseflix's People

Contributors

rbilag 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.