Getting Started

Prerequisites

• Node.js 24 (via nvm: nvm use)
• pnpm: npm install -g pnpm
• Docker (for the database)

Setup

# Clone the repo
git clone https://github.com/sebprunier/sanson.git
cd sanson

# Use the right Node version
nvm use

# Install dependencies
pnpm install

# Create your .env from the example
cp .env.example .env

Start the database

Sanson uses PostgreSQL 16 with PostGIS 3.4. A Docker Compose file is provided:

docker compose -f docker/compose.yml up -d

This starts PostgreSQL on port 5433 and automatically runs scripts/init.sql to create the metadata tables.

Start the API

pnpm dev

The API is available at http://localhost:3000. By default, NODE_MODE=all starts both the HTTP server and the background worker.

Start the admin UI

In a separate terminal:

pnpm --filter @sanson/admin dev

The admin UI is available at http://localhost:5173. It proxies API calls to the backend automatically.

Verify it works

# OGC landing page
curl http://localhost:3000/

# Health check (database connectivity)
curl http://localhost:3000/health

# List collections (empty at first)
curl http://localhost:3000/collections

What's next?

• Import your first dataset — upload a GeoJSON file and explore it
• Configuration — customize NODE_MODE, database URL, and more
• API Reference — explore the full OGC API