2026-05-28 08:35:50 -04:00
2026-05-28 08:35:25 -04:00
2026-05-28 08:35:50 -04:00
2026-04-29 00:26:58 -04:00

Cairnquire

Cairnquire is a Go-first documentation platform for serving Markdown as secure, fast HTML with room for later sync, collaboration, and offline features.

Current Status

This repository now contains the Milestone 1 foundation scaffold:

  • Go application server with chi routing, slog logging, config loading, and graceful shutdown
  • SQLite/libsql-oriented data layer with startup migrations
  • Markdown rendering pipeline with wiki-link rewriting, tag extraction, and SSR templates
  • Content-addressed attachment storage with secure serving
  • Preact + Vite frontend scaffold for later hydration-focused UI work
  • Docker, Compose, CI, OpenAPI, and local development targets

Quick Start

Prerequisites

  • mise
  • Docker (optional)
  • CGO-capable toolchain for go-libsql
  • air for Go live reload (go install github.com/air-verse/air@v1.65.1)

Install the pinned toolchain with:

mise install

Development Mode (with live reload)

Run both the Go server and Vite dev server with live reload:

mise run dev

This starts:

You can also run them separately in two terminals:

# Terminal 1 - Go server with live reload
mise run dev-server

# Terminal 2 - Vite dev server
mise run dev-web

Production Mode

Build the web app and run the Go server without Vite proxy:

mise run web-install
mise run web-build
mise run server-run

The server listens on http://localhost:8080 by default.

Common commands

mise run server-test
mise run server-build
mise run docker-build
mise run ci
mise run fmt

Configuration

Configuration can come from:

  1. config.json via CAIRNQUIRE_CONFIG
  2. Environment variables

Supported variables:

  • CAIRNQUIRE_SERVER_ADDR
  • CAIRNQUIRE_DATABASE_PATH
  • CAIRNQUIRE_DATABASE_PRIMARY_URL
  • CAIRNQUIRE_DATABASE_AUTH_TOKEN
  • CAIRNQUIRE_CONTENT_SOURCE_DIR
  • CAIRNQUIRE_CONTENT_STORE_DIR
  • CAIRNQUIRE_WEB_DIST_DIR
  • CAIRNQUIRE_DEV_VITE_URL - Set to proxy /app/* to Vite dev server (e.g. http://localhost:5173)
  • CAIRNQUIRE_LOG_LEVEL

Noted Gaps

  • The docs describe both a single-binary system and a separate Vite/Preact app. This implementation keeps the Go server as the primary runtime and treats the web app as compiled static assets.
  • The docs call for golang-migrate, but the current foundation uses an internal migration runner while go-libsql integration details are validated.
  • The sync docs describe JSON messages while the Milestone 1 layout mentions a protobuf package; both are preserved in packages/protocol/ pending a later protocol lock.
Description
No description provided
Readme 36 MiB
Languages
Go 56.1%
JavaScript 16.3%
Swift 16.3%
CSS 8.8%
Shell 2.3%
Other 0.2%