Skip to content
ShopNexus Docs
On this page The server 1/3

Before you start

Time: 15 min Who can do this: Developers
  • 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

  1. Start everything

    From server/:

    Terminal
    make run

    The first run copies .env.example to .env and 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.

  2. Fill in the model settings

    Search reads queries through a language model, and .env.example leaves LLM_API_KEY and LLM_MODEL empty. Until you set them in .env, the server refuses to start and names every variable it is missing.

  3. Check it is up

    GET /healthz answers as soon as the process runs. GET /readyz also checks Postgres and Restate.

  4. 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:

Terminal
./run.sh        # install the debug build and open it
./run.sh -w     # reinstall and reopen after every saved change

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

ShopNexus Docs
EN VI