feat: add docs

Sunny-unik · Sunny-unik · commit 5f6ed84cf7ec · 2024-03-06T23:35:17.000+05:30
diff --git a/README.md b/README.md
@@ -1,70 +1,32 @@
-# Getting Started with Create React App
+<div align="center">
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+# Stackinflow
 
-## Available Scripts
+> A Web App for Question & Answer about tech
 
-In the project directory, you can run:
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/Sunny-unik/stackinflow)
 
-### `npm start`
+</div>
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+## Tech Stack
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
+- Node/Express for server
+- React for frontend
+- Mongodb for database
 
-### `npm test`
+## 🤝 Contributing
 
-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.
+We encourage you to contribute to Stackinflow! All contributors are required to abide by our [Code of Conduct](/docs/Code-of-conduct.md). Please check out the [Contributing guide](/docs/Contributing.md) for guidelines about how to proceed with your contribution.
+Feel free for start discussion.
 
-### `npm run build`
+## Project Setup
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
+For development setup read [getting started guide](/docs/Getting-started-guide.md)
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
+# Deployment
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+This website is deployed on [render](https://render.com)
 
-### `npm run eject`
+## ⚖️ LICENSE
 
-**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)
+MIT © [Sunny-unik/Stackinflow](LICENSE)
diff --git a/client/README.md b/client/README.md
@@ -0,0 +1,70 @@
+# 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 [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.\
+You will 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)
diff --git a/docs/Code-of-conduct.md b/docs/Code-of-conduct.md
@@ -0,0 +1,80 @@
+---
+id: code-of-conduct
+title: Code of Conduct
+sidebar_label: Code of Conduct
+keywords:
+  - code of conduct
+---
+
+## Our pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <sunnygandhwani027@gmail.com>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/
diff --git a/docs/Contributing.md b/docs/Contributing.md
@@ -0,0 +1,82 @@
+# Contributing
+
+Thanks for your interest in contributing to Stackinflow.
+Contributions are always welcome, no matter how large or small.
+
+If you wish to contribute code, to get started we recommend first reading our [Getting Started Guide](Getting-started-guide.md).
+
+All other documentation for contributors can be found [in the docs directory](./).
+
+## Guidelines
+
+Before contributing, please read the [code of conduct](./code-of-conduct.md) and follow the directions below:
+
+### Recommended Communication Style
+
+1. Always leave screenshots for visual changes.
+2. Always leave a detailed description in the Pull Request. Leave nothing ambiguous for the reviewer.
+3. Always review your code first. Be sure to run the project locally and test before asking for a review.
+4. Always communicate in the GitHub repository. Whether it is in the issue or the pull request, keeping the lines of communication open and visible to everyone on the team helps everyone around you.
+
+### Applying Lint Styleguide
+
+#### To check the code for linting errors, run the following command
+
+```shell
+npm run lint
+```
+
+To fix the linting errors, run the following command:
+
+```shell
+npm run lint:fix
+```
+
+These commands use [ESLint](https://eslint.org/) to check and fix the code.
+
+#### To check the code for formatting errors, run the following command
+
+```shell
+npm run prettier
+```
+
+To fix the formatting errors, run the following command:
+
+```shell
+npm run prettier:fix
+```
+
+These commands use [Prettier](https://prettier.io/) to check and fix the code.
+
+Linting and formatting errors will also be displayed during development, but won't prevent the code from compiling.
+
+If you forget to run this command, automated pre-commit checks will also run these commands, but the commit will be blocked if there are any errors.
+
+## Pull requests
+
+**_We actively welcome your pull requests, however linking your work to an existing issue is preferred._**
+
+1. Fork the repo as [explained here](./Getting-started-guide.md) and create your branch from the default branch.
+2. Name your branch something that is descriptive to the work you are doing. i.e. adds-new-thing or fixes-mobile.
+3. If you make visual changes, screenshots are required.
+4. If you make the existing code better, please let us know in your PR description.
+5. A PR description and title are required. The title is required to begin with: "feat:" or "fix:"
+6. [Link to an issue](https://help.github.com/en/github/writing-on-github/autolinked-references-and-urls) in the project. Unsolicited code is welcomed, but an issue is required for an announcement your intentions. PR's without a linked issue will be marked invalid and closed.
+
+### PR Titles
+
+Examples for valid PR titles:
+
+- fix: Correct typo.
+- feat: Add support for Node 12.
+- refactor: Drop support for Node 6.
+
+_Note that since PR titles only have a single line, you have to use the ! syntax for breaking changes._
+
+See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for more examples.
+
+## Issues
+
+If you wish to work on an open issue, please get assign yourself to an issue before beginning work on it to avoid conflicts. For assign an issue to yourself comment on the issue `/attempt #issueNumber` to let us know that you want to work on this issue. Maintainer will check that issue is assigned to anyone else if not then maintainer assigned issue to you.
+
+In case you get stuck, please feel free to ask for help in the [Github Discussions](https://github.com/Sunny-unik/Stackinflow/discussions/categories/q-a).
diff --git a/docs/Getting-started-guide.md b/docs/Getting-started-guide.md
@@ -0,0 +1,43 @@
+# Getting Started Guide
+
+## Prerequisite
+
+1. Node installed on your machine.
+2. MongoDB URI to connect with Database.
+3. Check `extensions.json` file in .vscode directory so me of these extensions are required for maintain code consistency.
+
+## Setup
+
+1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the [Stackinflow](https://github.com/Sunny-unik/Stackinflow) to your own GitHub account.
+2. Clone the forked repository to your local machine.
+3. Create `.env` file and fill environment variables as following written in `.env.example` file.
+4. Goto server then run `npm i` to install the dependencies for server
+5. Goto server then run `npm i` to install the dependencies for frontend.
+
+## Development
+
+To run development server on your local machine, navigate inside server directory then run:
+
+```shell
+npm run watch
+```
+
+To run development frontend on your local machine, navigate inside client directory then run:
+
+```shell
+npm start
+```
+
+## Building
+
+To generate a production-ready version of your code, run:
+
+```shell
+npm run build
+```
+
+To test production-ready version of your code, run:
+
+```shell
+npm start
+```
diff --git a/server/Procfile b/server/Procfile
