You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(readme): refresh features, fix accuracy nits, strengthen story (#464)
* docs(readme): refresh features, fix accuracy nits, strengthen story
- Sync Features list with shipped app: My Festival (Want to try / Tasted),
tasting notes; surface accessibility and offline caching as differentiators
- Add intro framing the app for real festival conditions
- Fix accuracy nits: pin Flutter 3.44.0 (drop "or later"), use self-bootstrapping
./bin/mise install, make drink list consistent across the doc
- Point Contributing at the development guide, AGENTS.md, and the check gate
- Add a Screenshots section with a placeholder for device shots
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017GurzXkAkKjYF1GUdSEze8
* docs: consolidate deployment detail into ci-cd.md
The README duplicated the deployment mechanism already documented in
docs/processes/ci-cd.md, and the two had drifted. Trim the README's
Deployment section to a trigger→target summary plus links, keeping the
authoritative detail in ci-cd.md.
Also fix the stale preview/staging URLs in ci-cd.md: PR previews and
staging are served from the `staging-cambeerfestival` Pages project
(`<branch>.staging-cambeerfestival.pages.dev`, staging.cambeerfestival.app),
not `cambeerfestival.pages.dev`.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017GurzXkAkKjYF1GUdSEze8
* docs: address review — clarify mise prereq and fix deploy action name
- README: state Flutter is installed by ./bin/mise and a global mise is
optional; drop the now-redundant separate mise prerequisite bullet
- ci-cd.md: the staging/preview deploy uses cloudflare/wrangler-action@v4
(wrangler pages deploy), not cloudflare/pages-action@v1
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017GurzXkAkKjYF1GUdSEze8
---------
Co-authored-by: Claude <noreply@anthropic.com>
A Flutter app for browsing beers, ciders, meads, and more at the Cambridge Beer Festival.
12
+
A Flutter app for browsing, searching, and rating the beers, ciders, perries, meads, and wines on offer at the Cambridge Beer Festival — on Android, iOS, and the web.
13
+
14
+
Built for real festival conditions: the drinks list is cached so it keeps working when the venue network drops, and every screen is built with screen-reader semantics and keyboard/touch accessibility in mind.
_Screenshots coming soon — try the live app at [cambeerfestival.app](https://cambeerfestival.app)._
47
+
31
48
## Getting Started
32
49
33
50
### Prerequisites
34
51
35
-
-[Flutter SDK](https://docs.flutter.dev/get-started/install) (3.44.0 or later)
52
+
-**Flutter SDK 3.44.0** — pinned and installed for you by `./bin/mise` (the repo ships this wrapper, so a global [mise](https://mise.jdx.dev/) install is optional)
36
53
- Android Studio, Xcode, or VS Code with Flutter extensions
37
-
- (Optional) [mise](https://mise.jdx.dev/) for automatic tool version management
38
54
39
55
### Installation
40
56
@@ -43,8 +59,9 @@ A Flutter app for browsing beers, ciders, meads, and more at the Cambridge Beer
| Push to `main`| Staging — [staging.cambeerfestival.app](https://staging.cambeerfestival.app)|
180
+
| Open a pull request | A unique per-PR preview (`<branch>.staging-cambeerfestival.pages.dev`), posted as a comment on the PR |
181
+
| Push a version tag (e.g. `v2025.12.0`) | Production — [cambeerfestival.app](https://cambeerfestival.app)|
175
182
176
-
### Deployment Strategy
183
+
The app is hosted on Cloudflare Pages, with the API served by a Cloudflare Worker. For the full detail — every workflow, the Pages projects, and the release train:
177
184
178
-
1.**Development changes**: Push to `main` → Staging (Cloudflare Pages)
179
-
2.**PR reviews**: Open PR → Unique Cloudflare Pages preview created
180
-
3.**Production releases**: Create tag (e.g., `v2025.12.0`) → Production deployment to cambeerfestival.app
185
+
-[CI/CD](docs/processes/ci-cd.md) — each workflow and deploy job
-[Release Guide](docs/processes/release.md) — version bumping, branching, and tagging
181
188
182
-
For the full release process (version bumping, branching, tagging), see the [Release Guide](docs/processes/release.md).
189
+
## Contributing
183
190
184
-
For deployment setup and configuration, see [Cloudflare Pages Setup Guide](docs/tooling/cloudflare-pages.md).
191
+
Contributions are welcome! Before opening a pull request, please read:
185
192
186
-
## Contributing
193
+
-[Development Guide](docs/processes/development.md) — setup, workflows, and conventions
194
+
-[AGENTS.md](AGENTS.md) — architecture, code style, testing, and accessibility standards (written for AI agents, but the rules apply to everyone)
187
195
188
-
Contributions are welcome! Please feel free to submit a Pull Request.
196
+
Run `./bin/mise run check` (generate → analyze → test) before every commit, and follow [Conventional Commits](https://www.conventionalcommits.org/) for commit and PR titles.
0 commit comments