Skip to content

Latest commit

 

History

History
117 lines (93 loc) · 7.6 KB

README.md

File metadata and controls

117 lines (93 loc) · 7.6 KB
Raw

Netflix

A clone of the Netflix website using React.

This application uses React, React router, Styled-Components to build the Netflix Frontend Web application.

Working With this Project

To Run the Project in Development Mode

  1. Clone the Repository to your local machine: Run this in the terminalin the location you would like to save the repository locally:
git clone https://github.com/cynepton/netflix-clone.git

Or fork the repository and work on your own version.

  1. Install Dependencies: Enter the repository folder and install the dependencies. You need to have Node and NPM installed to run this step.
cd netflix-clone
npm install

This will install the dependencies based on the information in the package.json file.

  1. Environment Variables Create a .env file in the folder
touch .env

Copy the contents of the public env file, and paste in the .env file.

  1. Run the Application
npm start

React Components

All the components take in ...restProps which are the props for the component and spread it to the HTML tags within them. Please see the component structure to accurately understand where the props are placed. Most components also take {children}. Tags like the input tag do not take children since it doesn't need a closing tag and there is nothing to be nested within it's tags.

Jumbotron

See KarlHadwen's Youtube Video on Compound Components and Github Repo.

It's a Compound Component responsible for rendering the sections of the body of the webpage that contain the marketing boards. Currently, It renders each of the Jumbotron marketing items in the Jumbo Data JSON file. It also has the following sub-components:

  1. Jumbotron.Container defined in the Jumbotron Index.js file. Renders the Overall container for all the Jumbotron components that gets passed to the Jumbotron container JSX element that is in the jumbotron container file.
  2. Jumbotron.Pane defined in the Jumbotron Index.js file. The Jumbotron Pane renders it's contents which could be either text or an image. The Pane is half the width of the Jumbotron Div container within which it is placed.
  3. Jumbotron.Title defined in the Jumbotron Index.js file. This renders the Jumbotron Title H1 header within the Jumbotron Pane.
  4. Jumbotron.SubTitle defined in the Jumbotron Index.js file. This renders the Jumbotron SubTitle H2 header within the Jumbotron Pane.
  5. Jumbotron.Image defined in the Jumbotron Index.js file. This renders the Jumbotron Image within the Jumbotron Pane.

The CSS styles for the Jumbotron are located in the Jumbotron.js file. The Styled-Components library is used for the styling.

Footer

It's a Compound Component responsible for rendering the footer of the webpage. It also has the following sub-components:

  1. Footer.Container defined in the Footer Index.js file. Renders the Overall container for all the Footer components.
  2. Footer.Column defined in the Footer Index.js file. Renders each similar set of links within the footer. Refer to the Footer Container file to see how it is used.
  3. Footer.Row defined in the Footer Index.js file. This contains all the columns to be rendered
  4. Footer.Title defined in the Footer Index.js file. This renders the larger footer text.
  5. Footer.Link defined in the Footer Index.js file. This renders each footer text that should have a link.
  6. Footer.Text defined in the Footer Index.js file. This renders static footer text.
  7. Footer.Break defined in the Footer Index.js file. This renders a break to create spacing within the footer.

The CSS styles for the Footer are located in the Footer.js file. The Styled-Components library is used for the styling.

Accordion

It's a Compound Component responsible for rendering the accordion feature within the webpage. In this case, the accordion feature contains the FAQs, but it can also be reused elsewhere. It also has the following sub-components:

  1. Accordion defined in the Accordion Index.js file. Renders the Overall container for all the Footer components.
  2. Accordion.Frame defined in the Accordion Index.js file. Currently unused.
  3. Accordion.Inner defined in the Accordion Index.js file. Renders the inner div element within the full container. It may not always be necessary. In this case it is used to set the width of the actual accordion to be less than the full container width.
  4. Accordion.Title defined in the Accordion Index.js file. Renders the title of the Accordion component.
  5. Accordion.Item defined in the Accordion Index.js file. Contains each accordion item. The item contains the header and the body.
  6. Accordion.Header defined in the Accordion Index.js file. Renders the accordion header. When the accordion is closed, only the header shows.
  7. Accordion.Body defined in the Accordion Index.js file. Renders the contents of the accordion. When the header is clicked, it toggles the body to either open or close.

The CSS styles for the Accordion are located in the Accordion.js file. The Styled-Components library is used for the styling.

OptForm

It's a Compound Component responsible for rendering an input bar that allows the user to type in their email to subcribe to the service. It also has the following sub-components:

  1. OptForm defined in the OptForm Index.js file. Renders the container for the optForm.
  2. OptForm.Input defined in the OptForm Index.js file.
  3. OptForm.Button defined in the OptForm Index.js file.
  4. OptForm.Text defined in the OptForm Index.js file.
  5. OptFor.Break defined in the OptForm Index.js file. Renders a line break to seperate items within the flexbox.

The CSS styles for the Accordion are located in the OptForm.js file. The Styled-Components library is used for the styling.

React Router

The react router endpoints are defined in the Routes file. Any new routes should be added there to make it easier to monitor all the routes from a single location.

Home Page /

This is the base route and renders the home page defined in the Home Page File