> For the complete documentation index, see [llms.txt](https://cuesoft.gitbook.io/apparule/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cuesoft.gitbook.io/apparule/setup.md).

# Setup

## Prerequisites

* [Docker](https://www.docker.com/) & Docker Compose (recommended path)
* For native development: Go 1.26 (see `api/common/go.mod`), Node.js 24 (`web`), Python 3.12 (`api/measure`), Flutter (`mobile/flutter`)

## Configuration

Never commit secrets — provide configuration via `.env` / environment variables. Configuration comes from the root `.env` (copy `.env.example`).

| Variable               | Used by      | Description                                               |
| ---------------------- | ------------ | --------------------------------------------------------- |
| `JWT_SECRET`           | `api/common` | Secret for signing session JWTs.                          |
| `GOOGLE_CLOUD_PROJECT` | `api/common` | GCP / Firebase project id (auth).                         |
| `FIREBASE_CONFIG_PATH` | `api/common` | Optional path to a mounted Firebase service-account JSON. |
| `NEXT_PUBLIC_BASE_URL` | `web`        | Base URL of `api-common` as seen from the browser.        |

## Quick start (Docker)

```bash
cp .env.example .env
make up        # build + start api-common (:8080), api-measure (:8081), web (:3000)
make logs      # follow logs
make down      # stop and remove
```

* API (core): <http://localhost:8080> — health `/health`, readiness `/ready`
* API (measure): <http://localhost:8081> — health `/health`, readiness `/ready`
* Web: <http://localhost:3000>

`NEXT_PUBLIC_*` values are inlined into the web image at build time, so `make up` rebuilds the web image when they change.

## Running natively (without Docker)

```bash
# Go API — listens on :8080 (override with PORT)
cd api/common && go run ./cmd/server

# Python measurement service (FastAPI) — listens on :8081 (override with PORT)
cd api/measure && pip install -r requirements.txt && uvicorn app.main:app --port 8081

# Web (dev server)
cd web && npm install && npm run dev

# Mobile
cd mobile/flutter && flutter pub get && flutter run
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://cuesoft.gitbook.io/apparule/setup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.