Skip to content

Commit 0fc42ee

Browse files
committed
docs: add mobile app build instructions and iOS platform note
1 parent b6aed9a commit 0fc42ee

2 files changed

Lines changed: 30 additions & 1 deletion

File tree

CLAUDE.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ cargo clippy -- -D warnings
3939

4040
Backend uses `SQLX_OFFLINE=true` for Docker builds (no live DB needed at compile time). Locally, sqlx connects to Postgres at build time for query checking.
4141

42-
### Frontend only
42+
### Web app (Svelte)
4343

4444
```bash
4545
cd web
@@ -48,6 +48,21 @@ npm run dev # Vite dev server on :5173, proxies /api → localhost:3000
4848
npm run build # production build → web/dist/
4949
```
5050

51+
### Mobile app (iOS only)
52+
53+
```bash
54+
cd mobile
55+
flutter pub get
56+
flutter test
57+
58+
# Run on iOS simulator
59+
flutter run -d ios \
60+
--dart-define=BEEBEEBIKE_API_BASE_URL=http://127.0.0.1:3000 \
61+
--dart-define=BEEBEEBIKE_TILE_STYLE_URL=http://127.0.0.1:8080/tiles/assets/styles/colorful/style.json
62+
```
63+
64+
Platform scope: iOS only in v0.1. `ferrostar_flutter` (at `packages/ferrostar_flutter/`) is a path dependency and must be present.
65+
5166
### Static data (not in repo)
5267

5368
OSM extract and vector tiles must be downloaded before first run:

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,20 @@ Then open the app at `http://localhost:5173`.
2626

2727
Docker Compose files live at the project root and are meant to be run from there.
2828

29+
## Mobile app (iOS)
30+
31+
Flutter client in `mobile/`. Requires the `ferrostar_flutter` plugin at `packages/ferrostar_flutter/`.
32+
33+
```bash
34+
cd mobile
35+
flutter pub get
36+
flutter run -d ios \
37+
--dart-define=BEEBEEBIKE_API_BASE_URL=http://127.0.0.1:3000 \
38+
--dart-define=BEEBEEBIKE_TILE_STYLE_URL=http://127.0.0.1:8080/tiles/assets/styles/colorful/style.json
39+
```
40+
41+
> Android support is planned for a future release.
42+
2943
## Contributing
3044

3145
Contributions are welcome. Please open an issue first so we can talk through the idea, the shape of the change, and any bike-brain edge cases before you start building.

0 commit comments

Comments
 (0)