Skip to content

💎 Showcase: [Refinement] #483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
google-labs-jules wants to merge 1 commit into
base: main
Choose a base branch
from
Open

💎 Showcase: [Refinement] #483

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Magic Bracket Simulator

[ 🚀 Launch App ](https://magic-bracket-simulator.web.app) [ 📖 Documentation ](#documentation-map) [ 🐞 Report Bug ](https://github.com/TytaniumDev/MagicBracketSimulator/issues)
[ 🚀 Launch App ](https://magic-bracket-simulator.web.app) [ 📖 Documentation ](#documentation-map) [ 🐛 Report Bug ](https://github.com/TytaniumDev/MagicBracketSimulator/issues)

**Simulate thousands of Magic: The Gathering Commander games to predict tournament brackets. Powered by Forge.**

Expand All @@ -21,18 +21,13 @@

## Quick Start

**Just want to run simulations?** Download the desktop worker for your platform from the [latest release](https://github.com/TytaniumDev/MagicBracketSimulator/releases/latest) and double-click. macOS builds are Developer-ID signed + notarized; Windows builds will trip SmartScreen the first time — click *More info → Run anyway*. The worker self-updates from then on.
Download the [latest release](https://github.com/TytaniumDev/MagicBracketSimulator/releases/latest) of the desktop worker and run it. The worker supports **Cloud** and **Offline** modes.

The worker has two modes:
- **Cloud:** signs in with Google, picks up jobs from the shared Firestore queue. Results show on the [web leaderboard](https://magic-bracket-simulator.web.app).
- **Offline:** picks 4 bundled Commander precons, runs the bracket locally, keeps results on your machine.

**Want to run the whole stack locally for development?** See the [Deployment Guide](docs/DEPLOYMENT.md). The legacy Docker worker (`worker/`) is still in the repo and works, but the desktop worker (`worker_flutter/`) is the path going forward.
For full stack local development, refer to the [Deployment Guide](docs/DEPLOYMENT.md).

```bash
# Frontend + API
npm run install:all && npm run dev
# → http://localhost:5173

# Desktop worker (Flutter)
cd worker_flutter && flutter run -d macos # or: -d windows
Expand All @@ -59,6 +54,9 @@ cd worker_flutter && flutter run -d macos # or: -d windows
* [Stale Sweeper](docs/STALE_SWEEPER.md)
* [Sweeper Alerting](docs/SWEEPER_ALERTING.md)
* [Sweeper Alert Policy](docs/sweeper-alert-policy.yaml)
* [Worker Flutter App Check Setup](worker_flutter/docs/APP_CHECK_SETUP.md)
* [Worker Flutter Auth Setup](worker_flutter/docs/AUTH_SETUP.md)
* [Worker Flutter Sentry Setup](worker_flutter/docs/sentry-setup.md)

## Contributing

Expand Down
Loading