Skip to content

💎 Showcase: [Refinement] #390

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] #390

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
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,9 @@

## 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.
**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. For details on Cloud vs Offline modes, see the [Desktop Worker Guide](worker_flutter/README.md).

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.
**Want to run the whole stack locally for development?** See the [Deployment Guide](docs/DEPLOYMENT.md) for full instructions, or run the minimal commands below:

```bash
# Frontend + API
Expand All @@ -50,12 +46,17 @@ cd worker_flutter && flutter run -d macos # or: -d windows
* [Architecture Overview](docs/ARCHITECTURE.md)
* [Architecture Issues](docs/ARCHITECTURE_ISSUES.md)
* [API Reference](API.md)
* [API PRD](api/PRD.md)
* [App Check Setup (Worker)](worker_flutter/docs/APP_CHECK_SETUP.md)
* [Auth Setup (Worker)](worker_flutter/docs/AUTH_SETUP.md)
* [Data Flow](DATA_FLOW.md)
* [Deployment Guide](docs/DEPLOYMENT.md)
* [Desktop Worker Guide](worker_flutter/README.md)
* [Implementation Plan](docs/IMPLEMENTATION_PLAN_WORKER_SPLIT.md)
* [Mode Setup](docs/MODE_SETUP.md)
* [Precon Sync](docs/PRECON_SYNC.md)
* [Secrets Setup](docs/SECRETS_SETUP.md)
* [Sentry Setup (Worker)](worker_flutter/docs/sentry-setup.md)
* [Stale Sweeper](docs/STALE_SWEEPER.md)
* [Sweeper Alerting](docs/SWEEPER_ALERTING.md)
* [Sweeper Alert Policy](docs/sweeper-alert-policy.yaml)
Expand Down
Loading