https://github.com/azakiio/quickset
QuickSet Online is a real-time multiplayer card game inspired by the classic game Set!
https://github.com/azakiio/quickset
elixir phoenix phoenix-liveview
Last synced: over 1 year ago
JSON representation
QuickSet Online is a real-time multiplayer card game inspired by the classic game Set!
- Host: GitHub
- URL: https://github.com/azakiio/quickset
- Owner: azakiio
- Created: 2024-08-20T03:45:42.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T20:05:59.000Z (over 1 year ago)
- Last Synced: 2025-01-21T18:49:13.273Z (over 1 year ago)
- Topics: elixir, phoenix, phoenix-liveview
- Language: Elixir
- Homepage: https://quickset.online
- Size: 86.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# đ´ QuickSet Online
**QuickSet Online** is a real-time multiplayer card game inspired by the classic game [Set](https://en.wikipedia.org/wiki/Set_(card_game))! This project is completely open-source, and we'd love your contributions to make it even better! đ
đŽ **Live Demo**: [Play Now!](https://quickset.online)
## ⨠Features
- đšī¸ Real-time multiplayer with friends or random opponents.
- đ¨ Clean, responsive UI inspired by the original Set game.
- đ Automatic state synchronization for seamless gameplay.
- đ§âđģ Built using [Phoenix LiveView](https://github.com/phoenixframework/phoenix_live_view) and [Elixir](https://elixir-lang.org).
## đ Getting Started
Follow these instructions to set up the project locally.
### Prerequisites
- [Elixir](https://elixir-lang.org/install.html)
- [Phoenix Framework](https://hexdocs.pm/phoenix/installation.html)
- [PostgreSQL](https://www.postgresql.org/download/)
### Installation
1. **Clone the repository**:
```bash
git clone https://github.com/yourusername/quickset.online.git
cd quickset.online
```
2. **Install dependencies**:
```bash
mix deps.get
npm install --prefix assets
```
3. **Set up the database**:
```bash
mix ecto.setup
```
4. **Start the Phoenix server**:
```bash
mix phx.server
```
5. Visit `http://localhost:4000` to play locally.
## đ ī¸ Tech Stack
- **Backend**: Phoenix LiveView, Elixir
- **Frontend**: Tailwind CSS, JavaScript
- **Database**: PostgreSQL
## 𧊠How to Play
1. Players join the game via a shared URL.
2. Select 3 cards that form a valid "Set".
3. The first player to collect the most Sets wins!
For a full breakdown of the game rules, see the [Set card game Wikipedia page](https://en.wikipedia.org/wiki/Set_(card_game)).
## đī¸ Contributing
We â¤ī¸ contributions! If you'd like to contribute to the project, follow these steps:
1. **Fork** this repository.
2. **Create** a new branch (`git checkout -b feature/your-feature-name`).
3. **Commit** your changes (`git commit -m 'Add new feature'`).
4. **Push** your branch (`git push origin feature/your-feature-name`).
5. Open a **pull request** and we'll review it as soon as possible!
## đ Issues & Feedback
If you encounter any bugs đ or have suggestions for improvements đĄ, feel free to [open an issue](https://github.com/yourusername/quickset.online/issues).