From e463cab3c0c99c73225f574073ac89b7f433dd9b Mon Sep 17 00:00:00 2001 From: Ramakrushna Biswal <125277258+RamakrushnaBiswal@users.noreply.github.com> Date: Tue, 1 Oct 2024 10:19:27 +0530 Subject: [PATCH] Update README.md --- README.md | 98 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 96 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 18927820..1774d992 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,96 @@ -# BoardgameCafe - +# 🎲 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) +
+ +
+

+ + + + + + + + +

+ +## ✨ 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! + +## πŸ› οΈ Tech Stack +- **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) + +1. **Fork this repository** 🍴 and clone it to your local machine: + ```bash + git clone https://github.com/RamakrushnaBiswal/PlayCafe.git +2. **Install dependencies 🧩:** + ```bash + npm install +3. **Run the development server ⚑:** + ```bash + npm run dev +4. Open your browser at `http://localhost:3000` to see the project running! 🌟 + + +## 🀝 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 + +## πŸ“„ License + 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 + +- 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 + +
+
+
+ + + + +## ⭐Support + +- πŸ’° Become our [Sponsor](https://github.com/sponsors/RamakrushnaBiswal)! +- ⭐ Star our Repo + + +