add readme file

Emnaghz · Feb 10, 2024 · 7ac8e0d · 7ac8e0d
1 parent 7054e02
commit 7ac8e0d
Show file tree

Hide file tree

Showing 11 changed files with 23 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -1,46 +1,34 @@
-# Getting Started with Create React App and Redux
+# Netflix Clone Project
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app), using the [Redux](https://redux.js.org/) and [Redux Toolkit](https://redux-toolkit.js.org/) template.
+This project is a Netflix clone built using JavaScript, React, HTML, and CSS. It features a login and logout authentication flow with Google, Redux for state management, and integration with The Movie Database (TMDB) to fetch film information for the Netflix app.
 
-## Available Scripts
+## Features
 
-In the project directory, you can run:
+- User authentication with Google OAuth for login and logout functionality.
+- Redux implementation for efficient state management.
+- Integration with TMDB API to fetch movie information.
+- Responsive design for compatibility with various devices.
+- Netflix-like user interface for browsing and watching movies.
 
-### `npm start`
+## Clone Repository
+`git clone https://github.com/Emnaghz/Netflix-clone.git`
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
+## Overview
 
-The page will reload when you make changes.\
-You may also see any lint errors in the console.
+### Welcome Screen (Not Authenticated User)
+![](images/img1.png "Figure 1 : Welcome Screen")
 
-### `npm test`
+### Sign In / Sign Up Screen (with Error Handling)
+![](images/img2.png "Figure 2 : Sign In / Sign Up Screen")
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+### Home Screen
+![](images/img3.png "Figure 3 : Home Screen (1/2)")
 
-### `npm run build`
+![](images/img4.png "Figure 4 : Home Screen (2/2)")
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
+### Profile Screen
+![](images/img5.png "Figure 5 : Profile Screen")
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can't go back!**
-
-If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
-
-You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+## Contributing
+Contributions are welcome! If you find any issues or have suggestions.
diff --git a/images/img1.png b/images/img1.png
diff --git a/images/img2.png b/images/img2.png
diff --git a/images/img3.png b/images/img3.png
diff --git a/images/img4.png b/images/img4.png
diff --git a/images/img5.png b/images/img5.png
diff --git a/public/favicon.ico b/public/favicon.ico
diff --git a/public/index.html b/public/index.html
@@ -2,7 +2,6 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta name="theme-color" content="#000000" />
     <meta
@@ -24,7 +23,7 @@
       work correctly both with client-side routing and a non-root public URL.
       Learn how to configure a non-root public URL by running `npm run build`.
     -->
-    <title>React Redux App</title>
+    <title>Netflix Clone App</title>
   </head>
   <body>
     <noscript>You need to enable JavaScript to run this app.</noscript>

diff --git a/public/logo192.png b/public/logo192.png
diff --git a/public/logo512.png b/public/logo512.png
diff --git a/src/index.js b/src/index.js
@@ -17,7 +17,4 @@ root.render(
   </React.StrictMode>
 );
 
-// If you want to start measuring performance in your app, pass a function
-// to log results (for example: reportWebVitals(console.log))
-// or send to an analytics endpoint. Learn more: https://bit.ly/CRA-vitals
 reportWebVitals();