Quickstart

Prerequisites

Node.js 20.17 or newer
pnpm 10
Docker with Compose
A PostgreSQL-compatible local environment

Use pnpm only. Do not run npm, Yarn, or Bun commands in this workspace.

Configure and start Oynk

From the repository root:

cp .env.example .env
docker compose up -d postgres
pnpm install --frozen-lockfile
pnpm db:migrate
pnpm dev

The default local services are:

Service	URL
Public web app	`http://localhost:5173`
Operations console	`http://localhost:5174`
API	`http://localhost:4000`

The API can synchronize on startup and repeats at SYNC_INTERVAL_MINUTES. Public RPC endpoints may throttle historical reads; use reliable RPC providers for significant backfills.

Preview the documentation

Install the current Mintlify mint CLI in your development environment, then run:

pnpm docs:dev

The docs preview uses http://localhost:4173. Validate navigation, frontmatter, assets, and local links without the CLI:

pnpm --filter @oynk/docs typecheck

Validate the monorepo

pnpm typecheck
pnpm test
pnpm build

Do not claim production readiness from a successful local build. Review production readiness first.

⌘I

Start here

How Oynk works

Architecture

Stellar & Soroban

Platform

Indexing & analytics

Operate Oynk

Reference

Prerequisites

Configure and start Oynk

Preview the documentation

Validate the monorepo

​Prerequisites

​Configure and start Oynk

​Preview the documentation

​Validate the monorepo

Prerequisites

Configure and start Oynk

Preview the documentation

Validate the monorepo