Updated readme

README.md

@@ -1,70 +1,107 @@
-# Getting Started with Create React App
-
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
-
-## Available Scripts
-
-In the project directory, you can run:
-
-### `npm start`
-
-Runs the app in the development mode.\
-Open [https://localhost:3000](https://localhost:3000) to view it in your browser.
-
-The page will reload when you make changes.\
-You may also see any lint errors in the console.
-
-### `npm test`
-
-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.
-
-### `npm run build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-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/).
-
-### Code Splitting
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
-
-### Analyzing the Bundle Size
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
-
-### Making a Progressive Web App
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
-
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `npm run build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
+# CinemaCentral - A Netflix clone with GPT powered Search engine
+
+To view the application, click here → 🔥 [Cinema Central](https://www.google.com "Cinema Central") 🔥
+
+## 💻 Functional: 
+- Modules (Pages) 
+    - Module 1 - Authentication
+        - Feature 1 - Sign In
+        - Feature 2 - Sign up
+    - Module 2 - Browse
+        - Feature 1 - Movie Component
+            - Movie Trailer
+            - Movie Details
+        - Feature 2 - Secondary Component
+            - Movie Lists
+                - Now Playing Movies
+                - Popular Movies
+                - Trending Movies
+                - Top-rated Movies
+                - Upcoming Movies
+    - Module 3 - Movie Details
+    - Module 4 - Movie Watch
+    - Module 5 - GPT powered Search
+        - Feature 1 - Search
+        - Feature 2 - Recommendation
+
+## 🎯 Non-functional
+- Desktop-first
+- Responsive
+- Authentication
+- Offline Support
+- Unit & Integration Testing
+- Localization support for Search page
+- Versioning (github)
+- Performance 
+
+## 👨🏻‍💻Tech choices
+- ReactJS (scaffolded with CRA)
+- TailwindCSS
+- Single responsibility via Custom hooks
+- State management using React-Redux
+- Firebase for authentication backend
+- Routing using React-router-dom
+- Testing using Jest with React-testing-library
+
+
+## 💡Development sequence
+- Create React App
+- Configured TailwindCSS 
+- Header
+- Routing of App
+- Login Form
+- Sign up Form
+- Form Validation
+- useRef Hook
+- Firebase Setup
+- Deploying our app to production
+- Create SignUp User Account
+- Implement Sign In user Api
+- Created Redux Store with userSlice
+- Implemented Sign out 
+- Update Profile
+- BugFix: Sign up user displayName and profile picture update
+- BugFix: if the user is not logged in Redirect /browse to Login Page and vice-versa
+- Unsubscibed to the onAuthStateChanged callback
+- Add hardcoded values to the constants file
+- Regiter TMDB API & create an app & get access token
+- Get Data from TMDB now playing movies list API
+- Custom Hook for Now Playing Movies
+- Create movieSlice
+- Update Store with movies Data
+- Planning for MainContauiner & secondary container
+- Fetch Data for Trailer Video
+- Update Store with Trailer Video Data
+- Embedded the Yotube video and make it autoplay and mute
+- Tailwind Classes to make Main Container look awesome
+- Build Secondary Component
+- Build Movie List
+- build Movie Card
+- TMDB Image CDN URL
+- Made the Browsre page amazing with Tailwind CSS
+- usePopularMovies Custom hook
+- GPT Search Page
+- GPT Search Bar
+- (BONUS) Multi-language Feature in our App)
+- Get Open AI Api Key 
+- Gpt Search API Call
+- fetched gptMoviesSuggestions from TMDB
+- created gptSlice added data
+- Resused Movie List component to make movie suggestion container
+- Memoization
+- Added .env file
+- Adding .env file to gitignore
+- Made our Site Responsive
+
+
+## 📽️ Project Setup
+- Before starting the project please add .env file and add the following ENVs
+    - REACT_APP_OPENAI_KEY
+    - REACT_APP_TMDB_KEY
+    - REACT_APP_FIREBASE_APIKEY
+    - REACT_APP_FIREBASE_AUTHDOMAIN
+    - REACT_APP_FIREBASE_PROJECTID
+    - REACT_APP_FIREBASE_STORAGEBUCKET
+    - REACT_APP_FIREBASE_MESSAGINGSENDERID
+    - REACT_APP_FIREBASE_APPID
+    - REACT_APP_FIREBASE_MEASUREMENTID