Skip to content

💎 Showcase: [Refinement] #488

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

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions .jules/showcase.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@
* **Missing Contributing Guide:** [RESOLVED] Users looking to contribute have no clear entry point. `CONTRIBUTING.md` has been enhanced with project structure and testing details.
* **Deployment Info Clutter:** Deployment instructions were mixed with local run instructions, making the "Quick Start" hard to find. These have been moved to `docs/DEPLOYMENT.md`.
* **Misleading Quick Start:** The `npm run dev` command implied it started the full stack, but the worker required a separate process. This led to "PENDING" simulation states for new users.
* **Deployment Info Clutter in Quick Start:** The Quick Start section previously included a link to the Deployment Guide which confused local development with server deployment. This has been removed to keep the focus strictly on running locally.

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

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.
**Just want to run simulations?** Download the [latest desktop worker](https://github.com/TytaniumDev/MagicBracketSimulator/releases/latest) (macOS/Windows). The worker auto-updates and supports Cloud mode (Google sign-in) or Offline mode (local precons).

**Want to run the whole stack locally for development?**
```bash
# Frontend + API
npm run install:all && npm run dev
Expand Down
Loading