Welcome to the Chess Multiplayer Game project! This is a real-time multiplayer chess game that allows you to play chess with your friends online. The project consists of both a frontend and a backend, providing a seamless and interactive gaming experience.
Check out our Preview Video to see the game in action!
Check out the site live here or https://chessbuddy.vercel.app/
To get started with the game locally, follow these steps:
- Navigate to the
frontenddirectory using:
cd frontend
- Install frontend dependencies:
yarn
- Create two environment variables by making a
.envinfrontenddirectory
VITE_CLOUDINARY_API = <your-cloundinary-api-url>/image/upload
VITE_CHESSBUDDY_API = <chess-buddy-backend-api-url>- Start the frontend app:
yarn dev or npm run dev
The frontend app will be accessible at http://localhost:5173/
-
Create a
.envfile in thebackenddirectory. -
Set up the following environment variables in the
.envfile:
JWT_SECRET_KEY=your_secret_key
MONGO_URI=your_mongodb_uri
- Navigate to the
backenddirectory in a separate terminal:
cd backend
- Install backend dependencies:
yarn or npm install or npm i
- Start the backend server:
yarn dev or npm run dev
The backend server will run at http://localhost:4000/.
We welcome contributions from the community! To contribute to the project:
-
Fork the repository.
-
Clone your forked repository:
git clone <your-forked-rep-link>
-
Make your changes and improvements.
-
Commit and push your changes to your forked repository.
-
Create a pull request to the original repository. We'll review your changes and merge them if they meet the project's guidelines.
- Play chess in real-time with your friends.
- Interactive chessboard with valid move highlighting.
- Pawn promotion with underpromotion options.
- Castling and en passant move support.
- Frontend: React, Socket.IO, Cloudinary, AXIOS, React Query
- Backend: Node.js, Express, JWT, Mongoose, MongoDB, Socket.IO
For any questions or suggestions, feel free to contact us at [email protected].
Happy Coding! 🎉