Update README

[Mehak-Mattoo]

Feature Request: Update README for Project Setup and Issue Template

Summary

Update the project's README file to include detailed setup instructions and inform contributors about the issue template for reporting bugs and suggesting features.

Motivation

• Ease of Setup: New contributors often face challenges when setting up the project environment. Providing clear and concise setup instructions in the README will streamline this process.
• Recruiting more help for project: New contributors can easily understand how to raise issues and thereby will generate more help for the project.

Detailed Explanation

The README update should include the following sections:

1. Project Overview: Brief introduction to the project.
2. Prerequisites: List of software and tools required to set up the project (e.g., Node.js, npm, Docker).
3. Installation Instructions: Step-by-step guide to clone the repository, install dependencies, and run the project locally.
4. Usage: Basic usage instructions, including common commands for development and testing.
5. Contributing Guidelines: Instructions for contributing to the project, including how to fork the repository, create branches, and submit pull requests.
6. Issue Template: Description of the issue template and how to use it for reporting bugs and requesting features.

Examples and Mockups

Example of the README update:

# Project Name

## Project Overview
Brief description of the project.

## Prerequisites
- Node.js >= v12.0
- npm >= v6.0
- Docker (optional)

## Installation Instructions
1. Clone the repository:
    ```sh
    git clone https://github.com/yourusername/projectname.git
    cd projectname

2. Install dependencies:

   npm install

3. Run the project:

   npm start

Usage

• Start Development Server:

  npm run dev

Contributing Guidelines

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature/your-feature-name

3. Make your changes and commit them:

   git commit -m "Add your message"

4. Push to your fork:

   git push origin feature/your-feature-name

5. Create a pull request.

Issue Template

Please use the following issue template when reporting bugs or requesting features.

### Alternatives Considered
- **Video Tutorials:** Creating video tutorials for setup. While helpful, maintaining video content can be challenging.

### Additional Context
- Ensure the README is kept up-to-date with any changes to the setup process or dependencies.
- Consider adding links to external documentation or resources that can help with setup and development.

### Acceptance Criteria
- [ ] README includes a comprehensive section on project setup.
- [ ] README informs contributors about the issue template.
- [ ] README is clear, concise, and easy to follow for new contributors.
- [ ] Internal links and references are correct and functional.

### References
- [Markdown Guide](https://www.markdownguide.org)
- [Contributor Covenant](https://www.contributor-covenant.org)

[mdkaifansari04]

I guess it's been done @Mehak-Mattoo

[Mehak-Mattoo]

Yes, i did that in my PR