SpeedyGuesser ⚡

"Challenge your friends and find out who's the fastest at guessing! A race of intuition and speed."

---

Table of Contents 📚

• SpeedyGuesser ⚡
  • Table of Contents 📚
  • Project Description
  • How to Use 🛠️
  • Game Modes 🎮
    • Offline Mode
    • Single Mode
    • Local Mode
  • Technologies Used 🧰
  • Contributions 🤝
  • License 📜

---

Project Description

SpeedyGuesser is an engaging game where two teams compete to guess the most words in the shortest time possible.
The project is based on Create T3 App, which ensures a scalable and modern architecture for web applications.

• Current version: 1.0.0
• Developer: Lorenzo Bandini

---

How to Use 🛠️

Follow these steps to install and run the project locally.

1. Clone the repository:

   git clone https://github.com/lorenzobandini/speedyguesser.git

2. Navigate to the project folder:

   cd speedyguesser

3. Copy the .env.example file and customize your .env:

   cp .env.example .env

4. Install dependencies:

   pnpm install

5. Sync the prisma schema with the database:

   npx prisma db push

6. Populate the database with initial data:

   npx prisma db seed

7. Start the app in development mode:

   pnpm run dev

8. (Optional) Open Prisma Studio to manage the database:

   npx prisma studio

Note: SpeedyGuesser is a Progressive Web App (PWA) and can be installed on your device for a native experience.

---

Game Modes 🎮

SpeedyGuesser offers three game modes to suit every situation:

Offline Mode

• No authentication required.
• Play on a single device.
• Results are not saved.

Single Mode

• Requires authentication.
• Similar to offline mode, but results are saved.

Local Mode

• Requires authentication.
• Allows playing on multiple devices synchronized in real-time.
• Each player can choose their own role and results are saved.

---

Technologies Used 🧰

SpeedyGuesser has been built using a set of modern and performant technologies:

• TypeScript: For safer and more readable code.
• Next.js: React framework for creating server-rendered web applications.
• Tailwind CSS: For fast and responsive design.
• Prisma: ORM to interact with the database in a simple way.
• tRPC: For type-safe APIs between client and server.
• PWA: Supports installation and notifications.

---

Contributions 🤝

Want to contribute?
Follow these simple steps:

1. Fork the project.

2. Create a branch for your changes:

   git checkout -b feature/new-feature

3. Commit your changes:

   git commit -m "Add new feature"

4. Submit a pull request!

---

License 📜

This project is distributed under the MIT license.
See the LICENSE file for more details.