84 lines
1.3 KiB
Markdown
84 lines
1.3 KiB
Markdown
# WoW Raid Bingo
|
|
|
|
A Laravel + Livewire web app for running bingo-style games during World of Warcraft raids.
|
|
|
|
## Stack
|
|
|
|
- PHP 8.1+
|
|
- Laravel 10
|
|
- Livewire 2
|
|
- MySQL
|
|
- Tailwind CSS 2 + Laravel Mix
|
|
|
|
## Quick Start (Local)
|
|
|
|
1. Install dependencies:
|
|
|
|
```bash
|
|
composer install
|
|
npm install
|
|
```
|
|
|
|
2. Configure environment:
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
php artisan key:generate
|
|
```
|
|
|
|
3. Configure your database connection in `.env`, then run:
|
|
|
|
```bash
|
|
php artisan migrate --seed
|
|
```
|
|
|
|
4. Start the app:
|
|
|
|
```bash
|
|
php artisan serve
|
|
npm run dev
|
|
```
|
|
|
|
5. Open `http://127.0.0.1:8000`.
|
|
|
|
## Quick Start (Docker / Sail)
|
|
|
|
If you use Laravel Sail:
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
./vendor/bin/sail up -d
|
|
./vendor/bin/sail composer install
|
|
./vendor/bin/sail artisan key:generate
|
|
./vendor/bin/sail artisan migrate --seed
|
|
./vendor/bin/sail npm install
|
|
./vendor/bin/sail npm run dev
|
|
```
|
|
|
|
## Default Seeded Admin
|
|
|
|
Database seeding creates an admin user:
|
|
|
|
- Username: `admin`
|
|
- Password: `password`
|
|
|
|
Change this immediately for any shared or public environment.
|
|
|
|
## Important Routes
|
|
|
|
- `/setup` - game setup flow
|
|
- `/game` - bingo game view
|
|
- `/admin/login` - admin login
|
|
- `/admin` - admin dashboard (authenticated)
|
|
|
|
## Tests
|
|
|
|
Run the test suite with:
|
|
|
|
```bash
|
|
php artisan test
|
|
```
|
|
|
|
## License
|
|
|
|
MIT
|