Table of Contents

• Bingo Social
  • 🚀 What is Bingo Social?
  • ✨ Key Features
  • 🚀 Quick Start
    • Local Installation
  • 📦 Dependencies
  • 🧑‍💻 Usage
    • User Stories
    • Code Snippets
  • 🗺️ Roadmap
  • 📸 Screenshot
  • 🤝 Contributing
  • 📝 License

Bingo Social

A real-time bingo card creator for social events.

🚀 What is Bingo Social?

Bingo Social is a real-time bingo card creator that allows multiple users to play together in real-time. It's perfect for social events, company gatherings, or just for fun!

✨ Key Features

• Real-time updates: Thanks to Firebase Firestore, all users see the same bingo card and updates in real-time.
• No login required: Anyone with the link can access the card and play.
• Customizable cards: You can create your own bingo cards with custom text.
• Fun and interactive: A great way to engage with your friends, family, or colleagues.

🚀 Quick Start

To get started, you can either use the hosted version at bingo-social.web.app or run it locally.

Local Installation

1. Clone the repository:

   git clone https://github.com/JaviLopezG/bingo-social.git
   

2. Install the dependencies:

   cd bingo-social
   npm install
   

3. Run the development server:

   npm run dev
   

📦 Dependencies

• React
• Vite
• Firebase
• Tailwind CSS

🧑‍💻 Usage

User Stories

As a user, I want to be able to create a new bingo card with custom text.

As a user, I want to be able to share the bingo card with my friends.

As a user, I want to be able to see the bingo card updates in real-time.

Code Snippets

// src/App.jsx

import React from 'react';

const App = () => {
  return (
    <div className="App">
      <h1>Bingo Social</h1>
      {/* Your code here */}
    </div>
  );
};

export default App;

🗺️ Roadmap

This is a "weekend project" and future development depends on community interest. If you have any suggestions or feedback, please feel free to open an issue or a pull request.

📸 Screenshot

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

📝 License

This project is BSD-3-Clause licensed.