Brierly docs
v1.0.0
Get help
● Start

Installation
server first, then the app.

Commands below were taken from app/README.md and server/README.md and match the project files. The server and app steps were run while writing this guide, as noted.

npm ciflutter pub get

01Install and run the server

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. Check Node: node -v must print 22.12 or newer (26 is recommended).
  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}, and curl http://localhost:8787/v1/config prints the settings the app will read.
  5. Check the questions: curl http://localhost:8787/v1/questions lists open questions. They come from the question source set in the console (default: a public API read by your server), so the server needs outbound internet access. The list never contains the crowd's odds.
  6. Open the console at http://localhost:8787/admin (next page: Console).

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

Verified

npm ci, npm run build and npm start were run on Node 22.22.2 with npm 10.9.7. /healthz answered {"ok":true}, /v1/config answered with the defaults and /v1/questions returned open questions from the default public source. Not run by the author of this guide: Node 26, npm 11 (see Troubleshooting) and Docker.

02Install 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. Check the code and run the tests (they need no device):
    flutter analyze
    flutter test
    Both passed while writing this guide (analyze: no issues; test: 84 passed, 20 screen tests skipped by design).
  4. Run on a device with your server: add the server address at build time. Origin only, no trailing path, and it must be https.
    flutter run --dart-define=API_BASE_URL=https://your-server.example.com
    Pick the connected phone or simulator when asked.
  5. Without a server (flutter run alone) the app runs on its own: the question list shows an empty state, and history and scores keep working. No sample questions are bundled.
Why https only

The project does not allow plain http (no cleartext exception in AndroidManifest.xml, none in Info.plist). Current Android and iOS refuse such addresses, so for tests on a phone use a deployed server or an https tunnel. Testing with an http address was not tried (unverified).

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).

Not run on a real device

The code was analysed and the automated tests passed, but this guide's author did not run the app on a real phone or emulator. The drag slider, the sealing flow, purchases, the share card and CSV share are yours to test on your own devices before you publish.

03Do I need the server?

For a useful product, yes. The questions come only from the server; the app bundles none. Without it the app shows an empty list, though a user's earlier calls, scores and calibration still work. The server is also where you change the paywall, features, announcement and force update without a new build.