modified readme

[REHAN-18]

Summary by CodeRabbit

• Documentation
  • Added a "Docker Setup" section with instructions for building and running the application using Docker.
  • Expanded the "Contributing" section with structured guidelines for contributing to the project.
  • Updated the "Mentors" section to acknowledge mentor contributions.
  • Refined the "Support" section to include sponsorship options.
  • Enhanced the document with visual elements and minor formatting adjustments for better clarity and engagement.

[vercel]

@REHAN-18 is attempting to deploy a commit to the bunty's projects Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The changes to the README.md file enhance the documentation for the PlayCafe project by adding a "Docker Setup" section with detailed instructions on building and running the application using Docker. The "Contributing" section has been expanded to provide structured guidance on contributing to the project. Visual elements have been introduced, and updates have been made to the "Mentors" and "Support" sections. Minor formatting adjustments have also been applied throughout the document.

Changes

File	Change Summary
README.md	Added "Docker Setup" section with build/run instructions; expanded "Contributing" section; updated "Mentors" and "Support" sections; added visual elements; made minor formatting adjustments.

Possibly related PRs

• Added the Dockerfile #156: Introduces a "Docker Setup" section in the README.md, related to the changes made in this PR.
• Rearrange the structure of the README #294: Enhances the README.md by adding a "Docker Setup" section, aligning with the improvements made in this PR.

Suggested labels

documentation, level1, gssoc-ext, hacktoberfest accepted

Suggested reviewers

• RamakrushnaBiswal

🐇 In the garden where ideas bloom,
A README shines, dispelling gloom.
With Docker tips and ways to share,
Contributing made easy, so do beware!
Mentors praised, visuals in play,
Join the fun, come hop this way! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our CONTRIBUTING.md. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

README.md (2)

145-170: Excellent addition of contribution guidelines!

The new "How to Contribute" section provides clear and concise steps for potential contributors. This addition will greatly help newcomers understand the contribution process and encourage participation.

However, I have a minor suggestion to improve readability:

Consider using a numbered list for the contribution steps instead of headings. This will make the steps easier to follow and maintain consistent formatting. Here's an example of how it could look:

### 💵 How to Contribute

1. Fork the repository to your GitHub account.
2. Clone the forked repository to your local machine.
   ```bash
   git clone https://github.com/<github_username>/PlayCafe.git

3. Create a new branch for your changes.

   git checkout -b feature/your-feature

4. Make your changes, whether they're bug fixes, new features, or improvements.
5. Add the changes in your branch.

   git add .

6. Commit your changes with descriptive commit messages.

   git commit -m "Add your descriptive commit message here"
   git push origin feature/your-feature

7. Open a Pull Request (PR) against the main repository.

Additional Notes

• Start working on the issue, Don't wait to get it assigned by the maintainers
• Your every contribution counts, Thanks for contributing to PlayCafe

This format maintains the information while improving readability and consistency.

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 Markdownlint</summary><blockquote>

147-147: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

148-148: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

152-152: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

156-156: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

157-157: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

161-161: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

166-166: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

168-168: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

169-169: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

147-147: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

148-148: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

152-152: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

156-156: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

161-161: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

166-166: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

</blockquote></details>

</details>

---

Line range hint `184-465`: **Excellent update to the Contributors section!**

The expanded Contributors section with avatars, names, and GitHub links is a great way to recognize and appreciate all contributors to the project. The visual representation makes the section more engaging and the introductory message sets a positive tone.



To ensure this section remains up-to-date and manageable as the project grows, consider implementing an automated solution to update the contributors list. Tools like the `all-contributors` bot can help maintain this section with minimal manual intervention. This will ensure all contributors are recognized promptly and consistently.

Here's how you can set it up:
1. Install the All Contributors bot on your repository.
2. Use comments in issues and PRs to trigger the bot to add new contributors.
3. The bot will automatically update the README with new contributors.

This approach will help maintain an accurate and up-to-date list of contributors as your project continues to grow.

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 LanguageTool</summary><blockquote>

[grammar] ~131-~131: The verb ‘help’ is used with an infinitive.
Context: ...(GSSoC) Extended, an initiative to help aspiring developers get involved in the open-sou...

(ADVISE_VBG)

</blockquote></details>
<details>
<summary>🪛 Markdownlint</summary><blockquote>

147-147: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

148-148: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

152-152: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

156-156: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

157-157: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

161-161: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

166-166: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

168-168: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

169-169: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

147-147: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

148-148: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

152-152: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

156-156: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

161-161: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

166-166: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

</blockquote></details>

</details>

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**

<details>
<summary>📥 Commits</summary>

Files that changed from the base of the PR and between bd83a2542e4673132f31688ba5f60d30922dd52b and 6eea9bf746f06f41957dc0c055a4fc53311d77fd.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* README.md (1 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>



<details>
<summary>🪛 Markdownlint</summary><blockquote>

<details>
<summary>README.md</summary><blockquote>

147-147: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

148-148: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

152-152: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

156-156: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

157-157: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

161-161: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

166-166: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

168-168: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

169-169: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

147-147: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

148-148: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

152-152: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

156-156: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

161-161: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

166-166: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

</blockquote></details>

</blockquote></details>

</details>

<details>
<summary>🔇 Additional comments (3)</summary><blockquote>

<details>
<summary>README.md (3)</summary><blockquote>

`133-139`: **Great addition of program badges!**

The inclusion of GSSoC 2024 Extended and Hacktoberfest 2024 images enhances the README's visual appeal and clearly showcases the project's participation in these programs. This addition will likely attract more contributors and increase the project's visibility.

---

Line range hint `173-181`: **Great update to the Mentors section!**

The addition of a specific mentor, Shiva Bajpai, along with their role and GitHub profile link, adds credibility to the project and provides a clear point of contact for contributors seeking guidance. This update will help foster a supportive environment for contributors.

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 LanguageTool</summary><blockquote>

[grammar] ~131-~131: The verb ‘help’ is used with an infinitive.
Context: ...(GSSoC) Extended, an initiative to help aspiring developers get involved in the open-sou...

(ADVISE_VBG)

</blockquote></details>
<details>
<summary>🪛 Markdownlint</summary><blockquote>

147-147: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

148-148: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

152-152: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

156-156: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

157-157: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

161-161: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

166-166: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

168-168: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

169-169: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

147-147: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

148-148: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

152-152: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

156-156: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

161-161: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

166-166: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

</blockquote></details>

</details>

---

Line range hint `467-475`: **Great enhancement to the Support section!**

The updated Support section provides clear and actionable ways for users to contribute to the project's success. The inclusion of sponsorship options and the encouragement to star the repository are excellent additions that can help with project visibility and potentially, financial sustainability.

The thank you message at the end adds a nice personal touch and shows appreciation for the community's support. This update effectively communicates the value of user support to the project.

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 LanguageTool</summary><blockquote>

[grammar] ~131-~131: The verb ‘help’ is used with an infinitive.
Context: ...(GSSoC) Extended, an initiative to help aspiring developers get involved in the open-sou...

(ADVISE_VBG)

</blockquote></details>
<details>
<summary>🪛 Markdownlint</summary><blockquote>

147-147: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

148-148: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

152-152: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

156-156: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

157-157: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

161-161: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

166-166: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

168-168: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

169-169: null
Headings must start at the beginning of the line

(MD023, heading-start-left)

---

147-147: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

148-148: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

152-152: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

156-156: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

161-161: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

166-166: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

</blockquote></details>

</details>

</blockquote></details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->