Quick start
Run the server and its stack on your machine, put the Android app on a phone, and preview these docs.
Before you start
- Go 1.27 and Docker with Compose, for the server.
- JDK 21, the Android SDK with platform 36, and a phone on Android 12 or later (or an API 36 emulator), for the app.
- Bun, for the docs.
The server
-
Start everything
From
server/:Terminalmake runThe first run copies
.env.exampleto.envand adds fresh signing keys. Every run then starts the development stack, applies migrations, prepares the object store bucket and starts the server on port 8080. -
Fill in the model settings
Search reads queries through a language model, and
.env.exampleleavesLLM_API_KEYandLLM_MODELempty. Until you set them in.env, the server refuses to start and names every variable it is missing. -
Check it is up
GET /healthzanswers as soon as the process runs.GET /readyzalso checks Postgres and Restate. -
Create a console admin
The API cannot create admins. Run
go run ./cmd/console create-admin --email <email> --name <name>, and it prints a temporary password.
make down stops the stacks and keeps the development database.
The Android app
From app/, with a phone connected over adb:
./run.sh # install the debug build and open it
./run.sh -w # reinstall and reopen after every saved changeThe script picks a real phone over an emulator. To use an emulator, set ANDROID_SERIAL to its serial. The app runs on fake data with a simulated seller and carrier, so it does not need the server. In a debug build, a long press on the location pill on Home opens the debug panel, where you can jump a deal to any state or reset the data.
These docs
From docs/web, run bun install, then bun run dev to get a live preview at http://localhost:4321. Search only works after one bun run build, because the build writes the search index.