justEhmadSaeed · thezaeemaanwar · May 23, 2022 · May 23, 2022 · May 23, 2022 · May 23, 2022
diff --git a/Demo.mp4 b/Demo.mp4
diff --git a/README.md b/README.md
@@ -1,70 +1,27 @@
-# 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:
-
-### `yarn start`
-
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://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.
-
-### `yarn 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.
-
-### `yarn 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.
-
-### `yarn 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)
-
-### `yarn 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)
+![Survey Lit](/src/assets/logo.png)
+
+# Survey Lit 🔥
+
+A free online survey management platform which is easy to use and get data from the people on various topics.
+
+## Run the project locally 
+### 1. Clone and install 🖥️
+- Clone the repository using command: <pre>git clone https://github.com/justEhmadSaeed/survey-lit.git</pre>
+- Install necessary NPM packages using command <pre>npm install</pre>
+### 2. Configure Firease for your project 🛠️
+- Create Firebase account here https://firebase.google.com/
+- Create a new web project and enable Google and Email authentication
+- Create a Firestore database using the schema in root dirextory
+- Go to project settings in Firebase and copy API keys
+### 3. Environment Variables #️⃣
+- Create a file named ``.env``
+- Copy the contents of ``example.env`` and paste them into ``.env``
+- Replace you API keys
+### 4. Start the server 🚀
+- Start React server by using command <pre>npm start</pre>
+- The development server would start running on ``localhost:3000``
+- Make Your Changes and Enjoy :)
+
+## About the Developers
+1. Ehmad Saeed https://github.com/justEhmadSaeed
+2. Zaeema Anwar https://github.com/theZaeemaAnwar