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
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.
๐ Check out the live version of the website: Live Demo
- ๐ป 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!
- Frontend: JavaScript, React JS , Tailwind CSS
- Backend : Node.js, Express.js
- Database: MongoDB/MySQL
- Deployment: Vercel
Ready to contribute to this fun project? Here's how to set up your development environment:
Make sure you follow our contributing guidlines:- here
- Fork this repository ๐ด and clone it to your local machine:
git clone https://github.com/RamakrushnaBiswal/PlayCafe.git
- Install dependencies ๐งฉ:
npm install
- Run the development server โก:
npm run dev
- Open your browser at
http://localhost:3000
to see the project running! ๐
Set-up using Dockerfile(Male sure you installed docker in your PC):-
- Build Docker Image:
docker build -t playcafe .
- Run Docker Image
docker run -p 5173:5173 -p 3000:3000 playcafe
- Open your browser at
http://localhost:5173
to see the project running! ๐
Set-up using docker-compose :-
- Build Docker Image and Run the Application:
docker compose up --build
To run ESLint, use the following commands:
npm run lint
To automatically fix linting issues, run:
npm run lint:fix
To format your code with Prettier, use:
npm run format
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.
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.
Special thanks to our amazing mentors who are guiding this project! ๐
- [to be annouce] - Full Stack Developer
This project is licensed under the MIT License. See the LICENSE file for more details.
- 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
- ๐ฐ Become our Sponsor!
- โญ Star our Repo