Skip to content

Avik-creator/soduku-realtime

Repository files navigation

Realtime Sudoku

Play Sudoku with your friends in real-time! This project is a collaborative Sudoku game built with Next.js and Liveblocks, allowing multiple players to solve the puzzle together simultaneously.

Through this project my AIM was to learn about LiveBlocks and will soon write an blog about it.

🚀 Features

  • Real-time Multiplayer: Solve Sudoku puzzles with friends and see their moves live.
  • Multiple Difficulty Levels: Choose from Easy, Medium, Hard, Insane, and Inhuman.
  • User Authentication: Users can join with their names and avatars.
  • Live Chat: Communicate with other players while solving the puzzle.
  • Game Timer: Track your time and compete with friends.
  • Mistake Counter: Keeps track of incorrect entries (limited to 3 mistakes).
  • Undo & Redo: Easily undo or redo your moves.
  • Notes Mode: Jot down potential numbers in cells.
  • Input Validation: Enable real-time validation to highlight correct and incorrect numbers.
  • Invite Friends: Share the game link or QR code for easy invites.
  • Theme Toggle: Switch between light and dark modes.
  • Confetti Celebration: Enjoy a confetti burst when you complete the puzzle! 🎉

🛠️ Technologies Used

Frontend

Backend & Realtime

🚀 Getting Started

1️⃣ Clone the Repository

git clone https://github.com/Avik-creator/soduku-realtime
cd sudoku-realtime

2️⃣ Install Dependencies

npm install # or yarn install or pnpm install or bun install

3️⃣ Set Up Environment Variables

Create a .env.local file in the root directory and add your Liveblocks secret key:

LIVEBLOCKS_SECRET_KEY=sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Get your secret key from the Liveblocks Dashboard.

4️⃣ Run the Development Server

npm run dev # or yarn dev or pnpm dev or bun dev

5️⃣ Open in Browser

Visit http://localhost:3000 to access the application.

🚀 Deployment

The easiest way to deploy your Next.js app is with Vercel. Follow the Next.js Deployment Guide for detailed instructions.

📚 Learn More

Explore the following documentation:

🤝 Contributing

Contributions are welcome! If you have ideas for improvements or bug fixes, feel free to open an issue or submit a pull request.

📜 License

This project is open-source and licensed under the MIT License.


Enjoy playing Sudoku with your friends in real-time! 🎮

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors