updated readme file

This commit is contained in:
andres alcocer
2021-10-09 15:58:16 -04:00
parent 434c45f891
commit 4ba3e9fc32

View File

@@ -1,11 +1,12 @@
# Netflix Clone # Netflix Clone
- Demo: http://netflix-clone-react.surge.sh/ - Demo: <https://netflix-clone-9a0b9.firebaseapp.com/>
This project is a simplified front end clone of Netflix. It was created with React and CSS (Grid and Flexbox). It uses [The MovieDB Api](https://www.themoviedb.org/documentation/api) to search for movies and display details. Feel free to contribute! This project is a simplified front end clone of Netflix. It was created with React and CSS (Grid and Flexbox). It uses [The MovieDB Api](https://www.themoviedb.org/documentation/api) to search for movies and display details. Feel free to contribute!
### Tools used: ### Tools used
- Webpack
- Webpack
- Axios - Axios
- Redux & React - Redux & React
- Sass (grid & flexbox) - Sass (grid & flexbox)
@@ -13,24 +14,22 @@ This project is a simplified front end clone of Netflix. It was created with Rea
- Swiper JS - Swiper JS
### Runing Project Locally ### Runing Project Locally
- Install dependencies: run `npm install` in root project - Install dependencies: run `npm install` in root project
- Get API key from [here](https://www.themoviedb.org/documentation/api) - Get API key from [here](https://www.themoviedb.org/documentation/api)
- Create .env file in root project and add: `API_KEY=YOUR_API_KEY_HERE` - Create .env file in root project and add: `API_KEY=YOUR_API_KEY_HERE`
- Run project: `npm run dev` - Run project: `npm run dev`
### User Stories: ### User Stories
- User can search for movies and TV shows on TMDb - User can search for movies and TV shows on TMDb
- User can the see upcoming and trending movies. Data updates weekly - User can the see upcoming and trending movies. Data updates weekly
- User can click on a movie and a modal should pop up. It should display the title, release date, overview, and runtime. - User can click on a movie and a modal should pop up. It should display the title, release date, overview, and runtime.
- The webpage adapts to any screen size. - The webpage adapts to any screen size.
### Video Walktrough
### Video Walktrough
![](https://github.com/AndresXI/Netflix-Clone/blob/master/netflix-demo.gif?raw=true) ![](https://github.com/AndresXI/Netflix-Clone/blob/master/netflix-demo.gif?raw=true)
Please feel free to create a pull request and submit any issues! Please feel free to create a pull request and submit any issues!
Currently looking for backend developers. If you would to contribute to support a backend, reach out, all ideas are welcomed! Currently looking for backend developers. If you would to contribute to support a backend, reach out, all ideas are welcomed!