Quick Start

Quick Start

This guide gets the Kazier backend and the Android app running on your machine.

Prerequisites

Tool	Version
Go	1.26+
Docker	latest (for PostgreSQL)
Android Studio	latest stable
JDK	17

1. Clone the repository

git clone https://gitlab.thirdshop.fr/thirdshop/kasier.git
cd kasier

2. Start PostgreSQL

docker compose up -d postgres --wait

This starts a PostgreSQL 17 container with the database kazier_dev (user kazier, password kazier). See Docker Setup for details.

3. Run the backend

cd backend
go run cmd/server/main.go

The server listens on http://localhost:8080 by default. On first start it creates the admin account from ADMIN_USERNAME and ADMIN_PASSWORD (see Environment Variables).

# Health check
curl http://localhost:8080/api/v1/health
# → {"data":{"status":"healthy"}}

4. Run the Android app

Open the mobile-kotlin/ directory in Android Studio and run the app on an emulator or a connected device.

The emulator reaches your local backend through the default base URL:

http://10.0.2.2:8080/api/v1

On a physical device, configure the server URL in the app settings to point to your machine’s LAN address.

5. Verify the sync

1. Add a file to a SAF folder visible to the app.
2. The file is imported locally and shown in the app.
3. When you “keep” the file, its metadata is pushed to the backend through the outbox worker.

The server does not receive the physical file — only its metadata.

Tests

# Backend
cd backend && go test ./...

# Android (JVM unit tests)
cd mobile-kotlin && ./gradlew :app:testDebugUnitTest

Next steps

• Docker Setup
• Environment Variables
• API Reference