diff --git a/README.md b/README.md index de6c0e1..5715823 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,60 @@ -# Getting Started with Create React App and Redux +## Quora-Clone -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. +### Introduction -## Available Scripts +Quora-Clone is a simple clone of the popular Q&A website Quora, built using Redux and React. The project aims to provide a platform where users can ask and answer questions on various topics. -In the project directory, you can run: +### Features -### `npm start` +Currently, the project has the following features implemented: -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in your browser. +- **Google Authentication:** Users can log in and out using their Google accounts. +- **Question Creation:** Users can create new questions and add details. +- **Answer Submission:** Users can submit answers to existing questions. -The page will reload when you make changes.\ -You may also see any lint errors in the console. +### Installation -### `npm test` +To install the project, clone the repository and install the dependencies: -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. +``` +git clone https://github.com/your-username/Quora-Clone.git +cd Quora-Clone +npm install +``` -### `npm run build` +### Usage -Builds the app for production to the `build` folder.\ -It correctly bundles React in production mode and optimizes the build for the best performance. +To run the project, start the development server: -The build is minified and the filenames include the hashes.\ -Your app is ready to be deployed! +``` +npm start +``` -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. +The application will be available at `http://localhost:3000`. -### `npm run eject` +#### Creating a Question -**Note: this is a one-way operation. Once you `eject`, you can't go back!** +To create a question: -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. +1. Click on the "Ask Question" button in the top-right corner. +2. Fill out the question form with the question title, question body, and topics. +3. Click on the "Ask Question" button. -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. +#### Answering a Question -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. +To answer a question: -## Learn More +1. Navigate to the question page. +2. Click on the "Answer" button below the question. +3. Fill out the answer form with the answer body. +4. Click on the "Submit Answer" button. -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). +### Contribution Guidelines -To learn React, check out the [React documentation](https://reactjs.org/). +Contributions to the project are welcome. Please follow these guidelines when contributing: + +- Create a new branch for your changes. +- Write clear and concise commit messages. +- Add tests for your changes. +- Follow the project's coding style. +- Submit a pull request when your changes are ready for review.