Files
Europa/Nuvolari/README.md
T
Alby96andClaude Opus 5 4142b67a8d Record why the Android NDK is required
Hiding the NDK and rebuilding showed the build fails without it, and the reason
is not obvious from this repository: maplibre_gl pins ndkVersion 28.2.13676358
in its own build file, and AGP needs every module to agree on one NDK. The app
has no native sources and no Dart FFI, so the declaration reads like dead
configuration and invites exactly the deletion that was just tried.

Costs about 2 GB of Android SDK. Notes the full toolchain disk budget in the
README as well, since a warm Gradle cache plus build output pushes the total to
roughly 14 GB.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-10 11:44:23 +02:00

80 lines
2.9 KiB
Markdown

# Nuvolari
Precipitation radar for Piedmont, Italy. Android first, iOS later, one Flutter codebase.
Radar imagery comes from the public **Radar-DPC** platform, forecasts from **MET
Norway**, weather alerts from the **ARPA Piemonte** XML-CAP bulletin. The app is free
and ad-supported, with GDPR consent through Google's UMP.
Nuvolari is an independent app. It is not affiliated with, endorsed by, or operated by
ARPA Piemonte or the Dipartimento della Protezione Civile. For civil-protection
purposes the official channels always prevail.
## Layout
```
app/ Flutter application (Dart package "nuvolari")
backend/ Python worker: fetches DPC rasters, crops, reprojects, renders PNG frames
docs/ architecture, data sources, licenses, stack decisions, roadmap, privacy
tool/ verification scripts
```
Start with [docs/architecture.md](docs/architecture.md), then
[docs/roadmap.md](docs/roadmap.md) for what is built and what is next.
## Toolchain
| Tool | Version |
|---|---|
| Flutter | 3.47.3 stable (Dart 3.13.3) |
| Android SDK | platform 36, build-tools 36.0.0, platform-tools |
| JDK | 21 |
| Python | 3.12+ (3.14 works; rasterio ships wheels for it) |
| Android NDK | 28.2.13676358 — pinned by `maplibre_gl`, not by this project |
A full toolchain plus a warm Gradle cache needs roughly **14 GB** of disk: Flutter
3 GB, Android SDK 2.5 GB (2 GB of which is the NDK the map plugin pins), the Gradle
cache 5 GB, and build output around 2 GB. `flutter clean` reclaims the last of those.
## Configuration
Secrets never enter the repository. Copy the template and fill it in:
```bash
cp env.example.json env.json # env.json is git-ignored
```
| Key | Purpose |
|---|---|
| `MAP_STYLE_URL` | MapLibre style URL. Empty falls back to a local offline style. |
| `RADAR_MANIFEST_URL` | Base URL of the published `manifest.json`. |
| `RADAR_SOURCE` | `mock` (offline demo), `dpc` (live), `arpa` (disabled stub). |
| `METNO_USER_AGENT_CONTACT` | Contact address for the MET Norway User-Agent — **mandatory** for forecasts. |
| `ADMOB_APP_ID`, `ADMOB_BANNER_UNIT_ID` | Empty means Google's test ad units are used. |
## Running
```bash
cd app
flutter run --dart-define-from-file=../env.json
```
With no `env.json` the app starts in demo mode: mock radar frames from assets, offline
base map style, test ad units. No network and no credentials required.
## Verifying
```powershell
.\tool\verify.ps1 # format, analyze, test, build, lint, pytest
.\tool\verify.ps1 -SkipBuild # fast inner loop
```
Stages whose target does not exist yet are skipped, so this runs from day one.
## Attribution
Radar-DPC (CC BY-SA) · MET Norway (CC BY 4.0) · Arpa Piemonte ·
© OpenStreetMap contributors (ODbL). See [docs/licenses.md](docs/licenses.md) for the
obligations these carry — in particular, the rendered radar frames are a derived
product of CC BY-SA data and inherit share-alike.