Skip to content

Jay-1409/PlayCafe

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🎲 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, aiming to create a fun and immersive online presence.


πŸ“š Table of Contents

  1. ✨ Project Overview
  2. 🌐 Demo
  3. πŸ”₯ Features
  4. πŸ› οΈ Tech Stack
  5. βš™οΈ Getting Started / πŸ“₯ Installation
  6. πŸ“Œ Usage
  7. πŸ” API Documentation
  8. 🀝 Contributing
  9. 🎯 Open Source Programs
  10. 🌟 Mentors
  11. πŸ‘€ Our Contributors
  12. ⭐ Support
  13. πŸ“„ License
  14. πŸ“¬ 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.

🎯 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

πŸ”₯ Features

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

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 guidelines: here.

  1. Fork this repository 🍴 and clone it to your local machine:
    git clone https://github.com/RamakrushnaBiswal/PlayCafe.git
  2. Install dependencies 🧩:
    npm install
  3. Run the development server ⚑:
    npm run dev
  4. Open your browser at http://localhost:3000 to see the project running! 🌟

Docker Setup

Set up using Dockerfile (Make sure you have Docker installed):

  1. Build Docker Image
    docker build -t playcafe .
  2. Run Docker Image
    docker run -p 5173:5173 -p 3000:3000 playcafe
  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.

🀝 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! πŸ™Œ

Feel free to reach out for guidance and support throughout the development process!

πŸ‘₯ 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 PlayCafe to new heights! πŸš€

🌟 Show some love by giving a ⭐ to our repository!


RamakrushnaBiswal
Ramakrushna Biswal
samar12-rad
Samarth Vaidya
17arindam
Arindam
alo7lika
alolika bhowmik
Ashwinib26
Ashwini_ab
itznayan
Mahera Nayan
tejasbenibagde
Tejas Benibagde
Shirisha-16
Tyarla Shirisha
Amnyadav
Aman Yadav
NilanchalaPanda
Nilanchal
haseebzaki-07
Haseeb Zaki
Suhas-Koheda
Suhas Koheda
Jay-1409
Jay shah
vishnuprasad2004
Vishnu Prasad Korada
sajalbatra
Sajal Batra
PavanTeja2005
PavanTeja2005
AbhijitMotekar99
Abhijit Motekar
Navneetdadhich
Navneet Dadhich
Sawan-Kushwah
Sawan kushwah
VinayLodhi1712
Vinay Anand Lodhi
lade6501
Vishal Lade
Aditya90456
Aditya Bakshi
tanishirai
Tanishi Rai
Picodes10
Sushree Manaswini Biswal
Sourabh782
Sourabh Singh Rawat
Shiva-Bajpai
Shiva Bajpai
devxMani
MANI
Ayush215mb
Ayush Yadav
AliGates915
Ali Gates
chikatlarakesh
CHIKATLA RAKESH
mishradev1
Dev Mishra
jaidh01
Jai Dhingra
Mohitranag18
Mohit Rana
MutiatBash
Bashua Mutiat
Sapna127
Sapna Kul
stutxi
Stuti
Syed-Farazuddin
Syed Faraz
Vaibhav-Kumar-K-R
Vaibhav-Kumar-K-R

⭐ 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.
  • ⭐ 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 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.

✨ Join the Conversation

Stay updated and engage with our community on social media:

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

About

it a cafe websiteπŸš€

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 97.1%
  • TypeScript 1.4%
  • Other 1.5%