Skip to content

Commit

Permalink
Merge pull request #294 from alo7lika/main
Browse files Browse the repository at this point in the history 
Doc: Rearrange the structure of the README #285
  • Loading branch information
@RamakrushnaBiswal
RamakrushnaBiswal authored Oct 15, 2024
2 parents b79188c + 2a41ff0 commit 1867d35
Showing 1 changed file with 125 additions and 62 deletions.
187 changes: 125 additions & 62 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,116 +1,153 @@
# 🎲 PlayCafe Website
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-BADGE:END -->

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)
<div align="center">
<img src="https://github.com/user-attachments/assets/33f1ecfc-6a94-48ed-b79c-4ee0e37d8a77" width="600px" height="250px" >
</div>
<p align="center">
<a href="https://github.com/RamakrushnaBiswal/PlayCafe"><img src="https://badges.frapsoft.com/os/v1/open-source.svg?v=103"></a>
<a href="https://github.com/mdazfar2/"><img src="https://img.shields.io/badge/Maintained%3F-yes-brightgreen.svg?v=103"></a>
<a href="https://github.com/RamakrushnaBiswal/PlayCafe/blob/main/LICENSE"><img src="https://img.shields.io/badge/MIT-Licence-blue.svg?v=103"></a>
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.

<div align="center">
<img src="https://github.com/user-attachments/assets/33f1ecfc-6a94-48ed-b79c-4ee0e37d8a77" width="600px" height="250px">
</div>

<p align="center">
<a href="https://github.com/RamakrushnaBiswal/PlayCafe"><img src="https://badges.frapsoft.com/os/v1/open-source.svg?v=103"></a>
<a href="https://github.com/mdazfar2/"><img src="https://img.shields.io/badge/Maintained%3F-yes-brightgreen.svg?v=103"></a>
<a href="https://github.com/RamakrushnaBiswal/PlayCafe/blob/main/LICENSE"><img src="https://img.shields.io/badge/MIT-Licence-blue.svg?v=103"></a>
<a href="https://github.com/RamakrushnaBiswal/PlayCafe/graphs/contributors"><img src="https://img.shields.io/github/contributors/RamakrushnaBiswal/PlayCafe?color=brightgreen"></a>
<a href="https://github.com/RamakrushnaBiswal/PlayCafe/stargazers"><img src="https://img.shields.io/github/stars/RamakrushnaBiswal/PlayCafe?color=0059b3"></a>
<a href="https://github.com/RamakrushnaBiswal/PlayCafe/network/members"><img src="https://img.shields.io/github/forks/RamakrushnaBiswal/PlayCafe?color=yellow"></a>
<a href="https://github.com/RamakrushnaBiswal/PlayCafe/issues"><img src="https://img.shields.io/github/issues/RamakrushnaBiswal/PlayCafe?color=0059b3"></a>
<a href="https://github.com/RamakrushnaBiswal/PlayCafe/network/members"><img src="https://img.shields.io/github/forks/RamakrushnaBiswal/PlayCafe?color=yellow"></a>
<a href="https://github.com/RamakrushnaBiswal/PlayCafe/issues"><img src="https://img.shields.io/github/issues/RamakrushnaBiswal/PlayCafe?color=0059b3"></a>
</p>

<hr/>

## 📚 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. [👀 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.
<br>

🎯 **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:
<br>
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! 🌟**

## 📌 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.

## 🔍 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. |
| 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. |

Set-up using docker-compose :-

1. **Build Docker Image and Run the Application**:
```bash
docker compose up --build
## Please run it before pushing the code
To run ESLint, use the following commands:
```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.

<br>
<img src="https://github.com/user-attachments/assets/f7abbbe7-1950-4bf9-8456-c812ca630acf" style="width:400px">

## 🌟 Mentors

Special thanks to our amazing mentors who are guiding this project! 🙌

- **[to be annouce]** - Full Stack Developer
- **Shiva Bajpai**: Full Stack Developer
[GitHub Profile](https://github.com/Shiva-Bajpai)

## 📄 License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/RamakrushnaBiswal/PlayCafe/blob/main/LICENSE) file for more details.
Feel free to reach out for guidance and support throughout the development process!

## 👀 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.
- Make sure you show some love by giving ⭐ to our repository
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!

<br>
<center>
Expand Down Expand Up @@ -381,9 +418,35 @@ Special thanks to our amazing mentors who are guiding this project! 🙌


<!-- ALL-CONTRIBUTORS-LIST:END -->


## ⭐Support
## ⭐ 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 **PlayCafe**! 💖


## 📄 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.

- **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](https://discord.gg/Jh3bWQ7FRN)
- [LinkedIn](https://www.linkedin.com/in/ramakrushna-biswal/)
- [Email](mailto:[email protected])

We are always here to help you! Don’t hesitate to connect with us and be part of the PlayCafe journey.



- 💰 Become our [Sponsor](https://github.com/sponsors/RamakrushnaBiswal)!
- ⭐ Star our Repo

0 comments on commit 1867d35

Please sign in to comment.