From cdb54f2b24b16ff4180373bb45ef007a39415433 Mon Sep 17 00:00:00 2001
From: alolika bhowmik <152315710+alo7lika@users.noreply.github.com>
Date: Tue, 15 Oct 2024 10:52:30 +0530
Subject: [PATCH 01/10] Update README.md
---
README.md | 392 ++++++++++++------------------------------------------
1 file changed, 83 insertions(+), 309 deletions(-)
diff --git a/README.md b/README.md
index c540b7ca..6cc80595 100644
--- a/README.md
+++ b/README.md
@@ -1,121 +1,144 @@
# π² PlayCafe Website
-
+
-Welcome to the **[PlayCafe]** website repository! This project is part of **GirlScript Summer of Code (GSSoC) Extended** π. Our cafe offers a warm and exciting environment for board game enthusiasts to gather, relax, and enjoy great food. This repository contains the code for the cafe's official website, which aims to create a fun and immersive online presence.
-if you have any doubt about the project join [discord](https://discord.gg/Jh3bWQ7FRN)
-
-
-
-
-
-
-
+Welcome to the **[PlayCafe]** website repository! This project is part of **GirlScript Summer of Code (GSSoC) Extended** π. Our cafe offers a warm and exciting environment for board game enthusiasts to gather, relax, and enjoy great food. This repository contains the code for the cafe's official website, aiming to create a fun and immersive online presence.
+
+If you have any questions about the project, join our [Discord](https://discord.gg/Jh3bWQ7FRN).
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+## π Table of Contents
+1. [β¨ Project Overview](#-project-overview)
+2. [π Demo](#-demo)
+3. [π₯ Features](#-features)
+4. [π οΈ Tech Stack](#-tech-stack)
+5. [βοΈ Getting Started / π₯ Installation](#-getting-started--installation)
+6. [π Usage](#-usage)
+7. [π API Documentation](#-api-documentation)
+8. [π€ Contributing](#-contributing)
+9. [π― Open Source Programs](#-open-source-programs)
+10. [π Mentors](#-mentors)
+11. [π License](#-license)
+12. [π Our Contributors](#-our-contributors)
+13. [β Support](#-support)
+
## β¨ Project Overview
The **PlayCafe Website** project is an exciting open-source initiative under **GSSoC 2024 Extended**. We aim to build a modern and engaging website for the cafe, where visitors can learn about our games, book tables, and stay updated with our events and offers.
-
+
π― **Goal:** Create a seamless, user-friendly, and vibrant digital space for board game lovers.
## π Demo
π Check out the live version of the website: [Live Demo](https://play-cafe.vercel.app/)
## π₯ Features
-- **π» Responsive Design:** Optimized for all screen sizesβfrom mobile to desktop.
-- **ποΈ Event Booking System:** Users can book tables for upcoming events and game nights.
-- **π² Game Library:** Browse the collection of board games available at the cafe.
-- **πΈ Photo Gallery:** Sneak peeks into the cafe's ambiance and game nights.
-- **π Contact Form:** Easily get in touch with the cafe for any queries or feedback.
-- **π Special Offers:** Keep an eye out for exciting online deals and promotions!
+| Feature | Description |
+|-------------------------------|---------------------------------------------------------------|
+| π» Responsive Design | Optimized for all screen sizesβfrom mobile to desktop. |
+| ποΈ Event Booking System | Users can book tables for upcoming events and game nights. |
+| π² Game Library | Browse the collection of board games available at the cafe. |
+| πΈ Photo Gallery | Sneak peeks into the cafe's ambiance and game nights. |
+| π Contact Form | Easily get in touch with the cafe for any queries or feedback.|
+| π Special Offers | Keep an eye out for exciting online deals and promotions! |
## π οΈ Tech Stack
-- **Frontend:** JavaScript, React JS , Tailwind CSS
-- **Backend :** Node.js, Express.js
-- **Database:** MongoDB/MySQL
-- **Deployment:** Vercel
+| Technology | Description |
+|------------------|------------------------------------|
+| **Frontend** | JavaScript, React JS, Tailwind CSS |
+| **Backend** | Node.js, Express.js |
+| **Database** | MongoDB/MySQL |
+| **Deployment** | Vercel |
## βοΈ Getting Started / π₯ Installation
-
Ready to contribute to this fun project? Here's how to set up your development environment:
-Make sure you follow our contributing guidlines:- [here](https://github.com/RamakrushnaBiswal/PlayCafe/blob/main/CONTRIBUTING.md)
+Make sure you follow our contributing guidelines: [here](https://github.com/RamakrushnaBiswal/PlayCafe/blob/main/CONTRIBUTING.md).
1. **Fork this repository** π΄ and clone it to your local machine:
```bash
git clone https://github.com/RamakrushnaBiswal/PlayCafe.git
-2. **Install dependencies π§©:**
+ ```
+2. **Install dependencies π§©**:
```bash
npm install
-3. **Run the development server β‘:**
+ ```
+3. **Run the development server β‘**:
```bash
npm run dev
-4. Open your browser at `http://localhost:3000` to see the project running! π
-
-Set-up using Dockerfile(Male sure you installed docker in your PC):-
+ ```
+4. **Open your browser at http://localhost:3000 to see the project running! π**
-1. **Build Docker Image**:
+## Docker Setup
+**Set up using Dockerfile (Make sure you have Docker installed):**
+1. **Build Docker Image**
```bash
docker build -t playcafe .
+ ```
2. **Run Docker Image**
```bash
docker run -p 5173:5173 -p 3000:3000 playcafe
-3. Open your browser at `http://localhost:5173` to see the project running! π
+ ```
+3. **Open your browser at http://localhost:5173 to see the project running! π**
-Set-up using docker-compose :-
+## π Usage
+Once the application is running, you can:
+- Navigate through the website to explore different sections.
+- Book a table for an event.
+- Contact us for inquiries.
-1. **Build Docker Image and Run the Application**:
- ```bash
- docker compose up --build
+## π API Documentation
+The PlayCafe website communicates with a backend API to manage data. Hereβs a brief overview of available API endpoints:
-## Please run it before pushing the code
-To run ESLint, use the following commands:
+| HTTP Method | Endpoint | Description |
+|-------------|----------------|------------------------------------------|
+| GET | `/api/games` | Fetches the list of available games. |
+| POST | `/api/bookings`| Books a table for an event. |
+| GET | `/api/events` | Retrieves upcoming events. |
+| POST | `/api/contact` | Sends a message through the contact form.|
-```bash
- npm run lint
-```
-To automatically fix linting issues, run:
-```bash
- npm run lint:fix
-```
-To format your code with Prettier, use:
-```bash
- npm run format
-```
## π€ Contributing
We love contributions! π Whether you're a participant in **GSSoC** or an open-source enthusiast, we welcome your input. Here's how you can contribute:
-
- **π Create Issues**: If you find any bugs or have feature suggestions, feel free to open an issue.
- **π¨ Submit Pull Requests**: Got a fix or new feature? Fork the repo, create a new branch, and submit a pull request.
## π― Open Source Programs
This project is part of **GirlScript Summer of Code 2024** (GSSoC) Extended, an initiative to help aspiring developers get involved in the open-source community.
+
## π Mentors
Special thanks to our amazing mentors who are guiding this project! π
-- **[to be annouce]** - Full Stack Developer
+- **[to be announced]** - Full Stack Developer
## π License
- This project is licensed under the MIT License. See the [LICENSE](https://github.com/RamakrushnaBiswal/PlayCafe/blob/main/LICENSE) file for more details.
+This project is licensed under the MIT License. See the [LICENSE](https://github.com/RamakrushnaBiswal/PlayCafe/blob/main/LICENSE) file for more details.
-## π Our Contributors
+## π Our Contributors
+We extend our heartfelt gratitude for your invaluable contribution to our project! Your efforts play a pivotal role in elevating HelpOps-Hub to greater heights.
-- We extend our heartfelt gratitude for your invaluable contribution to our project! Your efforts play a pivotal role in elevating HelpOps-Hub to greater heights.
-- Make sure you show some love by giving β to our repository
+Make sure you show some love by giving β to our repository.
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-## βSupport
-
-- π° Become our [Sponsor](https://github.com/sponsors/RamakrushnaBiswal)!
-- β Star our Repo
+
+
From 89c16bc275d80ec10ded9bf6c8ffebbe0dcddf04 Mon Sep 17 00:00:00 2001
From: alolika bhowmik <152315710+alo7lika@users.noreply.github.com>
Date: Tue, 15 Oct 2024 11:03:43 +0530
Subject: [PATCH 02/10] Update README.md
---
README.md | 115 ++++++++++++++++++++++++++++++++++++++++++++++++------
1 file changed, 104 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 6cc80595..a0316709 100644
--- a/README.md
+++ b/README.md
@@ -34,9 +34,10 @@ If you have any questions about the project, join our [Discord](https://discord.
8. [π€ Contributing](#-contributing)
9. [π― Open Source Programs](#-open-source-programs)
10. [π Mentors](#-mentors)
-11. [π License](#-license)
-12. [π Our Contributors](#-our-contributors)
-13. [β Support](#-support)
+11. [π Our Contributors](#-our-contributors)
+12. [β Support](#-support)
+13. [π License](#-license)
+14. [π¬ Contact Us](#-Contact-Us)
## β¨ Project Overview
The **PlayCafe Website** project is an exciting open-source initiative under **GSSoC 2024 Extended**. We aim to build a modern and engaging website for the cafe, where visitors can learn about our games, book tables, and stay updated with our events and offers.
@@ -126,19 +127,16 @@ This project is part of **GirlScript Summer of Code 2024** (GSSoC) Extended, an
Special thanks to our amazing mentors who are guiding this project! π
- **[to be announced]** - Full Stack Developer
+
+## π₯ Our Contributors
-## π License
-This project is licensed under the MIT License. See the [LICENSE](https://github.com/RamakrushnaBiswal/PlayCafe/blob/main/LICENSE) file for more details.
+We extend our heartfelt gratitude to all the amazing contributors who have made this project what it is today. Your efforts are driving **HelpOps-Hub** to new heights! π
-## π Our Contributors
-We extend our heartfelt gratitude for your invaluable contribution to our project! Your efforts play a pivotal role in elevating HelpOps-Hub to greater heights.
-
-Make sure you show some love by giving β to our repository.
+### π Show some love by giving a β to our repository!
+
+---
+
+## β Support
+
+Your support keeps us going! Here's how you can help:
+
+- **π° Sponsor us**: Become a sponsor and help us keep growing. [Become a Sponsor](https://github.com/sponsors/RamakrushnaBiswal).
+- **β Star our Repo**: Show some love by starring the repository. Your stars motivate us to continue developing and improving!
+
+Thank you for supporting **HelpOps-Hub**! π
+
+
+## π License
+This project is licensed under the MIT License. See the [LICENSE](https://github.com/RamakrushnaBiswal/PlayCafe/blob/main/LICENSE) file for more details.
+
+## π¬ Contact Us
+
+Weβd love to hear from you! Whether you have questions, feedback, or collaboration ideas, feel free to reach out.
+
+- **Email**: [contact@playcafe.com](mailto:contact@playcafe.com)
+- **Twitter**: [@PlayCafe](https://twitter.com/PlayCafe)
+- **LinkedIn**: [PlayCafe](https://www.linkedin.com/company/playcafe)
+- **GitHub Issues**: [Submit a New Issue](https://github.com/PlayCafe/issues)
+
+### β¨ Join the Conversation
+
+Stay updated and engage with our community on social media:
+
+- **Discord**: [Join our Community](https://discord.gg/playcafe)
+- **Instagram**: [Follow us on Instagram](https://instagram.com/playcafe)
+- **Facebook**: [Like us on Facebook](https://facebook.com/playcafe)
+
+We are always here to help you! Donβt hesitate to connect with us and be part of the PlayCafe journey.
+
+
From e0ddce83d5d5444fc2b954de772f14ceb553bfdd Mon Sep 17 00:00:00 2001
From: alolika bhowmik <152315710+alo7lika@users.noreply.github.com>
Date: Tue, 15 Oct 2024 11:09:40 +0530
Subject: [PATCH 03/10] Update README.md
---
README.md | 206 ++++++++++++++++++++++++++++++++++++++++++++++++++----
1 file changed, 191 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
index a0316709..5b5ecc96 100644
--- a/README.md
+++ b/README.md
@@ -5,8 +5,6 @@
Welcome to the **[PlayCafe]** website repository! This project is part of **GirlScript Summer of Code (GSSoC) Extended** π. Our cafe offers a warm and exciting environment for board game enthusiasts to gather, relax, and enjoy great food. This repository contains the code for the cafe's official website, aiming to create a fun and immersive online presence.
-If you have any questions about the project, join our [Discord](https://discord.gg/Jh3bWQ7FRN).
-
@@ -137,6 +135,7 @@ We extend our heartfelt gratitude to all the amazing contributors who have made
-
+
+
+
+
+
+
+
+
+
----
+
## β Support
@@ -238,18 +419,13 @@ This project is licensed under the MIT License. See the [LICENSE](https://github
Weβd love to hear from you! Whether you have questions, feedback, or collaboration ideas, feel free to reach out.
-- **Email**: [contact@playcafe.com](mailto:contact@playcafe.com)
-- **Twitter**: [@PlayCafe](https://twitter.com/PlayCafe)
-- **LinkedIn**: [PlayCafe](https://www.linkedin.com/company/playcafe)
- **GitHub Issues**: [Submit a New Issue](https://github.com/PlayCafe/issues)
### β¨ Join the Conversation
Stay updated and engage with our community on social media:
-- **Discord**: [Join our Community](https://discord.gg/playcafe)
-- **Instagram**: [Follow us on Instagram](https://instagram.com/playcafe)
-- **Facebook**: [Like us on Facebook](https://facebook.com/playcafe)
+[Discord](https://discord.gg/Jh3bWQ7FRN).
We are always here to help you! Donβt hesitate to connect with us and be part of the PlayCafe journey.
From 96fe974b64bbb49323bb89e993173deb06c440df Mon Sep 17 00:00:00 2001
From: alolika bhowmik <152315710+alo7lika@users.noreply.github.com>
Date: Tue, 15 Oct 2024 11:20:30 +0530
Subject: [PATCH 04/10] Update README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 5b5ecc96..874a91ac 100644
--- a/README.md
+++ b/README.md
@@ -35,7 +35,7 @@ Welcome to the **[PlayCafe]** website repository! This project is part of **Girl
11. [π Our Contributors](#-our-contributors)
12. [β Support](#-support)
13. [π License](#-license)
-14. [π¬ Contact Us](#-Contact-Us)
+14. [π¬ Contact Us](#-contact-us)
## β¨ Project Overview
The **PlayCafe Website** project is an exciting open-source initiative under **GSSoC 2024 Extended**. We aim to build a modern and engaging website for the cafe, where visitors can learn about our games, book tables, and stay updated with our events and offers.
From f1e1c30d2bee95d8b08a6b0e2ba4a56e983b3e62 Mon Sep 17 00:00:00 2001
From: alolika bhowmik <152315710+alo7lika@users.noreply.github.com>
Date: Tue, 15 Oct 2024 11:56:06 +0530
Subject: [PATCH 05/10] Update README.md
---
README.md | 29 +++++++++++++++++++++--------
1 file changed, 21 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 874a91ac..a4209935 100644
--- a/README.md
+++ b/README.md
@@ -103,12 +103,24 @@ Once the application is running, you can:
## π API Documentation
The PlayCafe website communicates with a backend API to manage data. Hereβs a brief overview of available API endpoints:
-| HTTP Method | Endpoint | Description |
-|-------------|----------------|------------------------------------------|
-| GET | `/api/games` | Fetches the list of available games. |
-| POST | `/api/bookings`| Books a table for an event. |
-| GET | `/api/events` | Retrieves upcoming events. |
-| POST | `/api/contact` | Sends a message through the contact form.|
+| HTTP Method | Endpoint | Description |
+|-------------|-----------------------|--------------------------------------------------------|
+| GET | `/api/games` | Fetches the list of available games. |
+| POST | `/api/bookings` | Books a table for an event. |
+| GET | `/api/events` | Retrieves upcoming events. |
+| POST | `/api/contact` | Sends a message through the contact form. |
+| GET | `/api/users` | Retrieves a list of registered users. |
+| GET | `/api/users/:id` | Fetches details of a specific user by ID. |
+| PUT | `/api/users/:id` | Updates user information based on user ID. |
+| DELETE | `/api/users/:id` | Deletes a user from the system by ID. |
+| GET | `/api/menus` | Retrieves the menu items available at PlayCafe. |
+| POST | `/api/orders` | Places a new order for food and beverages. |
+| GET | `/api/orders/:id` | Fetches details of a specific order by ID. |
+| GET | `/api/reviews` | Retrieves customer reviews for the cafe. |
+| POST | `/api/reviews` | Submits a new review for a game or event. |
+| GET | `/api/bookings/:id` | Retrieves details of a specific booking by ID. |
+| DELETE | `/api/bookings/:id` | Cancels a specific booking by ID. |
+
## π€ Contributing
We love contributions! π Whether you're a participant in **GSSoC** or an open-source enthusiast, we welcome your input. Here's how you can contribute:
@@ -123,8 +135,7 @@ This project is part of **GirlScript Summer of Code 2024** (GSSoC) Extended, an
## π Mentors
Special thanks to our amazing mentors who are guiding this project! π
-
-- **[to be announced]** - Full Stack Developer
+@Shiva-Bajpai- Full Stack Developer
## π₯ Our Contributors
@@ -426,6 +437,8 @@ Weβd love to hear from you! Whether you have questions, feedback, or collabora
Stay updated and engage with our community on social media:
[Discord](https://discord.gg/Jh3bWQ7FRN).
+[Linkedin](https://www.linkedin.com/in/ramakrushna-biswal/)
+[Gmail](ramakrushnabunty@gmail.com)
We are always here to help you! Donβt hesitate to connect with us and be part of the PlayCafe journey.
From 273f14d389fb3e98ad568e6e714b0449cc85aa8e Mon Sep 17 00:00:00 2001
From: alolika bhowmik <152315710+alo7lika@users.noreply.github.com>
Date: Tue, 15 Oct 2024 11:57:56 +0530
Subject: [PATCH 06/10] Update README.md
---
README.md | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index a4209935..2269698d 100644
--- a/README.md
+++ b/README.md
@@ -436,10 +436,11 @@ Weβd love to hear from you! Whether you have questions, feedback, or collabora
Stay updated and engage with our community on social media:
-[Discord](https://discord.gg/Jh3bWQ7FRN).
-[Linkedin](https://www.linkedin.com/in/ramakrushna-biswal/)
-[Gmail](ramakrushnabunty@gmail.com)
+- [Discord](https://discord.gg/Jh3bWQ7FRN)
+- [LinkedIn](https://www.linkedin.com/in/ramakrushna-biswal/)
+- [Email](mailto:ramakrushnabunty@gmail.com)
We are always here to help you! Donβt hesitate to connect with us and be part of the PlayCafe journey.
+
From 3051b192bfab39b9dd3bd6ac4d8c86bd6716bc4b Mon Sep 17 00:00:00 2001
From: alolika bhowmik <152315710+alo7lika@users.noreply.github.com>
Date: Tue, 15 Oct 2024 11:59:39 +0530
Subject: [PATCH 07/10] Update README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 2269698d..91f89a44 100644
--- a/README.md
+++ b/README.md
@@ -135,7 +135,7 @@ This project is part of **GirlScript Summer of Code 2024** (GSSoC) Extended, an
## π Mentors
Special thanks to our amazing mentors who are guiding this project! π
-@Shiva-Bajpai- Full Stack Developer
+[@Shiva-Bajpai] - Full Stack Developer
## π₯ Our Contributors
From 34a47d029d9fcc4cfec1280b97ffd522a6ed2e76 Mon Sep 17 00:00:00 2001
From: alolika bhowmik <152315710+alo7lika@users.noreply.github.com>
Date: Tue, 15 Oct 2024 12:02:16 +0530
Subject: [PATCH 08/10] Update README.md
---
README.md | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 91f89a44..b69f4281 100644
--- a/README.md
+++ b/README.md
@@ -134,8 +134,14 @@ This project is part of **GirlScript Summer of Code 2024** (GSSoC) Extended, an
## π Mentors
+
Special thanks to our amazing mentors who are guiding this project! π
-[@Shiva-Bajpai] - Full Stack Developer
+
+- **Shiva Bajpai**: Full Stack Developer
+ [GitHub Profile](https://github.com/Shiva-Bajpai)
+
+Feel free to reach out for guidance and support throughout the development process!
+
## π₯ Our Contributors
From b54ad813bb190415130294bad2929d37f5bcbc0c Mon Sep 17 00:00:00 2001
From: alolika bhowmik <152315710+alo7lika@users.noreply.github.com>
Date: Tue, 15 Oct 2024 13:25:54 +0530
Subject: [PATCH 09/10] Update README.md
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index b69f4281..29393211 100644
--- a/README.md
+++ b/README.md
@@ -145,7 +145,7 @@ Feel free to reach out for guidance and support throughout the development proce
## π₯ Our Contributors
-We extend our heartfelt gratitude to all the amazing contributors who have made this project what it is today. Your efforts are driving **HelpOps-Hub** to new heights! π
+We extend our heartfelt gratitude to all the amazing contributors who have made this project what it is today. Your efforts are driving **PlayCafe** to new heights! π
### π Show some love by giving a β to our repository!
@@ -426,7 +426,7 @@ Your support keeps us going! Here's how you can help:
- **π° Sponsor us**: Become a sponsor and help us keep growing. [Become a Sponsor](https://github.com/sponsors/RamakrushnaBiswal).
- **β Star our Repo**: Show some love by starring the repository. Your stars motivate us to continue developing and improving!
-Thank you for supporting **HelpOps-Hub**! π
+Thank you for supporting **PlayCafe**! π
## π License
From 2a41ff02b0b547604e7b808e0eb1e45b5d7250d8 Mon Sep 17 00:00:00 2001
From: alolika bhowmik <152315710+alo7lika@users.noreply.github.com>
Date: Tue, 15 Oct 2024 13:34:17 +0530
Subject: [PATCH 10/10] Update README.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 29393211..79a7e062 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,7 @@ Welcome to the **[PlayCafe]** website repository! This project is part of **Girl
2. [π Demo](#-demo)
3. [π₯ Features](#-features)
4. [π οΈ Tech Stack](#-tech-stack)
-5. [βοΈ Getting Started / π₯ Installation](#-getting-started--installation)
+5. [βοΈ Getting Started / π₯ Installation](#οΈ-getting-started--installation)
6. [π Usage](#-usage)
7. [π API Documentation](#-api-documentation)
8. [π€ Contributing](#-contributing)