Kompakkt Server

Requirements

• Bun - runtime and package manager. npm / yarn / pnpm are not supported.
• MongoDB - primary data store.
• Redis (or a compatible drop-in such as Dragonfly) - cache layer.
• Sonic - full-text search backend.
• Kompressor - mesh processing backend (3d meshes, gaussian splatting, point clouds, ...).

The Kompakkt configuration for Sonic is available at sonic-config.cfg in the Kompakkt/Mono repository.

Development setup

Clone the repository, then install the dependencies with Bun:

git clone https://github.com/Kompakkt/Server
cd Server
bun install

Shared code from upstream Kompakkt packages (@kompakkt/common) is pulled in automatically as a git-pinned npm dependency.

Starting the supporting services

Make sure MongoDB, Redis/Dragonfly, Sonic and Kompressor are running locally (see the CONFIGURATION_* environment variables in src/configuration.ts for the hostnames, ports and credentials the server expects by default). Also see "Running the full stack" below.

Starting the server

For local development with hot reload:

bun run dev

The server listens on port 3030 by default.

Running the full stack

This repository only contains the Server. To run Server, Repo and Viewer together (with all required supporting services such as Redis, Sonic, MongoDB and Kompressor), use the Kompakkt/Mono development environment.