Loudline docs
v1.0.0
DemoDemo console Get help
● Start

Installation
app and server, step by step.

Commands below were taken from app/README.md and server/README.md and match the project files.

flutter pub getnpm ci

01Install and run the app

Windows users

Flutter runs natively on Windows: use PowerShell for the flutter commands and Android builds (iOS builds need a Mac). For the server, either install Node.js 22.12+ for Windows and use PowerShell (replace cp .env.example .env with Copy-Item .env.example .env; there is no openssl by default, so use WSL or any random 64-character hex string), or run the commands in WSL 2 (Ubuntu) or Docker. macOS and Linux users can ignore this note.

  1. Open a terminal in the app folder.
  2. Download packages:
    flutter pub get
  3. Run the tests (they need no device):
    flutter test
  4. Run on a device:
    flutter run
    Pick the connected phone or simulator when asked.
  5. With your server: add the address at build time. Origin only, no trailing path.
    flutter run --dart-define=API_BASE_URL=https://loudline.example.com
    Without it the app uses its built-in defaults and never contacts any server.
iOS first time

Run cd ios && pod install if Flutter asks for it, then open app/ios/Runner.xcworkspace in Xcode, select the Runner target, Signing & Capabilities, and choose your own team. The project ships with no team set (DEVELOPMENT_TEAM is empty), so Xcode asks for yours before the first device build.

02First device test

Never run on a real device

The author built the app for Android (flutter build apk --release) and for iOS (flutter build ios --no-codesign) and ran the automated tests (110 pass). The Kotlin and Swift codec bridges compile and are in the builds, but they have never run on a real device or a simulator. Reading compressed files, writing the .m4a copy, playback, the share-in, notifications and purchases are covered by unit tests and code reading only. Test them on your own phones before you publish.

  1. Pick an .m4a file (for example a voice memo), make a copy and play it.
  2. Pick an .mp3 file and do the same.
  3. Pick a video file (the app reads its audio) and check that the exported file is an audio file.
  4. Share the copy and play it in your music or voice-memo player to be sure the .m4a plays.

Also listen to a copy made with noise reduction switched on. The noise reduction was checked with numbers (the noise floor falls and the loudness stays on target), not by ear.

03Install and run the server

  1. Check Node: node -v must print 22.12 or newer.
  2. Create the settings file:
    cd server
    cp .env.example .env
  3. Make a secret key and paste it after ADMIN_SECRET_KEY= in .env:
    openssl rand -hex 32
    Keep a copy somewhere safe. It encrypts the store keys you save in the console.
  4. Install, build, start:
    npm ci
    npm run build
    npm start
    The server listens on port 8787. Test it: curl http://localhost:8787/healthz prints {"ok":true} (server/src/app.ts).
  5. Open the console at http://localhost:8787/admin (next: Console).

Development shortcut: npm run dev builds and starts. Full check (type check, lint, tests, build): npm run check.

04Do I need the server?

No. The app works fully offline with built-in defaults (four presets, built-in limits, no announcement). The server is for operators who want to change the paywall, limits without Pro, feature switches, file limits and presets, show announcements, force an update, see opt-in install counts, and confirm purchases with the stores.