🎵 Allegretto App

Allegretto Eisteddfod — the official mobile app for managing entries, syllabi, performance dates, and QR validation for the Allegretto Eisteddfod competition.

---

📱 Features

• Entry Forms — Browse and open entry form PDFs
• Syllabus — View the official Allegretto syllabus
• Dates & Deadlines — Stay on top of closing dates
• Region Schedules — Per-region performance dates with notifications
• QR Validation — Scan and validate entry QR codes
• Offline Library — Download and access PDFs offline (Pro)
• Push Notifications — Get alerted on updates and regional changes

---

🛠 Prerequisites

Tool	Version
Flutter SDK	3.16+ (see .fvm/flutter_sdk)
Firebase project	Auth, Firestore, Storage, Cloud Messaging
AdMob account	For ad units

---

🚀 Setup

1. Clone & decrypt secrets

Windows

scripts\decrypt.ps1
# Password: ask the team

macOS / Linux

chmod +x scripts/decrypt.sh
./scripts/decrypt.sh
# Password: ask the team

This creates .env (gitignored) with the API keys needed at build time.

2. Get dependencies

flutter pub get

3. Run or build

# Run on connected device
flutter run

# Build APK (Android)
flutter build apk --debug

# Build IPA (iOS — requires Apple Developer account)
flutter build ios --debug

4. Update encrypted secrets

Edit .env, then re-encrypt:

scripts\encrypt.ps1
# Enter new password or keep the same one

Commit the updated .env.enc.

---

🤖 Codemagic CI/CD

This repo includes codemagic.yaml for automatic builds on push.

Setup

1. Go to codemagic.io and sign in with GitHub
2. Add this repository
3. In Environment variables, add:

Variable	Value
ENCRYPTION_PASSWORD	The .env.enc password (ask the team) — mark as encrypted
EMAIL	Your email for build notifications

4. Push to main — Codemagic will build APK + IPA automatically

iOS signing

To produce installable IPAs, you'll need:

1. An Apple Developer account ($99/year)
2. Upload your App Store Connect API key or certificates in Codemagic > Teams > Apple Developer Portal
3. Update codemagic.yaml to add codesigning (remove --no-codesign and add signing config)

Without codesigning, the built .app can only run in the iOS simulator.

---

🔐 Firebase config files

The following files are checked into the repo and required at build time:

File	Purpose
android/app/google-services.json	Android Firebase config
ios/Runner/GoogleService-Info.plist	iOS Firebase config
lib/firebase_options.dart	Generated Firebase options

These contain public Firebase configuration (API keys are restricted by app ID, not secrecy).

---

📄 License

This software is All Rights Reserved. See LICENSE for terms.