Go to file

Claude Fable 5 f0850eecd3 All checks were successful CD / Build and push images (push) Successful in 1m46s Details CI / Lint, typecheck, test (push) Successful in 1m19s Details CI / Auth e2e pack (push) Successful in 1m42s Details CI / Build container images (push) Has been skipped Details CD / Deploy to Test (push) Successful in 8s Details CD / Smoke tests against Test (push) Successful in 1m5s Details CD / Promote to Int (push) Successful in 10s Details Ponds: data model, CRUD API, personal pond on verification (#21 ) - Pond model with pond-level trash columns (ADR 0013) and settings jsonb holding only deviations from the defaults (sidebar sort, font slots per ADR 0016); migration 20260705090100_ponds - shared: pond schemas/views and slugify (German transliteration, URL-safe, length-capped); deterministic -2/-3 suffixes for collisions - InterimAccessService: single place answering pond access questions until the real role model lands in M5 - POST/GET /ponds, GET /ponds/:slug, PATCH/DELETE /ponds/:id, Site-Admin trash + restore; personal pond auto-created on e-mail verification and for active seed fixtures; personal ponds cannot be trashed - e2e pack covering verify-flow pond creation, slug suffixes, rename, foreign-pond 404s, trash/restore; slugify unit tests Closes #21 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UpQz6ypHJsLfMf4S6fyQEB		2026-07-05 11:08:16 +02:00
.gitea/workflows	Run the CI auth pack against the production build	2026-07-05 06:16:27 +02:00
apps	Ponds: data model, CRUD API, personal pond on verification (#21 )	2026-07-05 11:08:16 +02:00
deploy	Make stage mail + base URL configurable; seed password overrides	2026-07-05 10:42:32 +02:00
docs/architecture	Scaffold pnpm monorepo with lint, format, and test tooling	2026-07-04 19:06:27 +02:00
packages/shared	Ponds: data model, CRUD API, personal pond on verification (#21 )	2026-07-05 11:08:16 +02:00
scripts	Run the CI auth pack against the production build	2026-07-05 06:16:27 +02:00
.dockerignore	Add production Dockerfiles and the Compose stack with dev overlay	2026-07-04 19:30:21 +02:00
.editorconfig	Scaffold pnpm monorepo with lint, format, and test tooling	2026-07-04 19:06:27 +02:00
.gitignore	Fire the e-mail verification exactly once per token	2026-07-05 05:59:25 +02:00
.prettierignore	Exclude the CI pnpm store from lint and git	2026-07-05 00:25:34 +02:00
.prettierrc.json	Scaffold pnpm monorepo with lint, format, and test tooling	2026-07-04 19:06:27 +02:00
eslint.config.mjs	Run the CI auth pack against the production build	2026-07-05 06:16:27 +02:00
LICENSE	Add architecture documentation, ADRs, and operations concept	2026-07-04 14:36:16 +02:00
package.json	Scaffold pnpm monorepo with lint, format, and test tooling	2026-07-04 19:06:27 +02:00
pnpm-lock.yaml	Add auth, settings, and admin UI to the SPA	2026-07-05 05:35:56 +02:00
pnpm-workspace.yaml	Add user, identity, session, and auth-support data model	2026-07-05 00:42:22 +02:00
README.md	Scaffold pnpm monorepo with lint, format, and test tooling	2026-07-04 19:06:27 +02:00
tsconfig.base.json	Scaffold pnpm monorepo with lint, format, and test tooling	2026-07-04 19:06:27 +02:00

README.md

Dorfteich

Dorfteich is an open-source wiki system built around ponds (German: Teiche) — self-contained wiki spaces that people and teams organize freely with hierarchical labels, directories, and Obsidian-style page relations. Pages are edited in a collaborative WYSIWYG editor with live cursors and offline support.

Project site: https://dorfteich.cloud
Public flagship instance: https://dorfteich.online
License: MIT

Key features

Real-time collaboration — multiple people edit the same page simultaneously; everyone sees the other participants' cursors and input live. Offline edits merge conflict-free on reconnect (CRDT-based).
Ponds — isolated wiki spaces with their own members, permissions, fonts, and page organization. Every registered person gets a personal pond.
Flexible organization — hierarchical labels, free page ordering, [[wikilinks]] with backlinks. A classic page tree is possible but never enforced.
Fine-grained permissions — roles (Site Admin, Pond Admin, Editor, Reader, Public) can be granted per pond, per label, or per page; the most specific setting wins.
Import & export — Markdown as the primary exchange format, plus best-effort structural import from Word/OpenOffice and export to Word/OpenOffice/PDF.
Plugins — sandboxed extensions (custom blocks, styles, page tools) installable at runtime without redeploying the instance.
Self-hosting first — a single docker compose up plus a guided first-run setup wizard yields a working instance.

Repository layout

Path	Contents
`docs/architecture/`	Architecture documentation: ADRs, data model, permission model, collaboration and plugin concepts, deployment and operations
`apps/`	Application packages (web frontend, API server, collaboration server) — created as implementation proceeds
`packages/`	Shared packages (types, permission logic, plugin SDK)
`deploy/`	Docker Compose stacks and deployment tooling

Development

Requirements: Node.js ≥ 22 and pnpm (npm install -g pnpm).

pnpm install        # install all workspace dependencies
pnpm lint           # ESLint + Prettier check across the repo
pnpm typecheck      # TypeScript --noEmit in every package
pnpm test           # Vitest in every package
pnpm build          # build every package (dependency order)

The workspace packages live under apps/ (web, api, collab) and packages/ (shared). Shared logic goes into packages/shared and is imported as @dorfteich/shared — never copy code between apps.

Status

The project is in the architecture and backlog phase. Implementation stories are tracked as issues in this repository. Start reading at docs/architecture/README.md.

Contributing

Code, comments, and documentation are written in English. Write clear code that humans can follow easily; when in doubt, prefer readability over cleverness. All contributions are accepted under the MIT license.