2026-10-30 13:33:51 -05:00

PubScript

A self-hostable, multi-user writing studio for novelists — one codebase that runs as a web app and as a native desktop app, with a local-first AI co-writing engine built in.

See PLAN.md for the full vision, architecture, and data model. The CHUNK#n.md files are the executable work orders.

Quickstart

pnpm i && pnpm dev      # run the app shell at http://localhost:5173
pnpm test               # run every workspace's unit tests
pnpm typecheck          # strict TypeScript across the monorepo
pnpm build              # build web + server

Docker (self-host)

docker compose -f docker/compose.yaml up --build
# → http://localhost:8080   (health: curl localhost:8080/api/health)

One container serves the web app, runs the Fastify API, and stores SQLite on a volume.

Repository layout

Path What it is
PLAN.md Single source of truth for what and why
CHUNK#n.md Executable, step-by-step work orders
apps/web/ React 19 + Vite app (runs in browser AND in Tauri)
packages/core/ Domain types, ULIDs, time, token budget, StorageAdapter contract
packages/ui/ Design tokens, theme engine (Ink / Parchment / Nocturne / Terminal), component kit
server/ Fastify + SQLite: auth, multi-tenant, WS, admin, AI proxy
docker/ Dockerfile + compose (one container serves app + API + data)
docs/ ADRs, data model reference, AI role prompts, parity matrix

Status

CHUNK #1 through #10 are complete and CI-green: the monorepo with strict TypeScript, the collapsible app shell and theming/density system, the packages/core contracts, the Fastify multi-tenant server, the TipTap writing surface with an OnlyOffice/Word-inspired formatting toolbar (34 fonts, line numbers, focus mode, alignment, indentation, lists, scene breaks, footnotes), characters & world-building, the plot & whiteboard surface, the export pipeline (Markdown/HTML/EPUB/DOCX/ODT/PDF with an ExportDialog), offline hunspell-WASM spellcheck + grammar checking, the AI provider & agent layer (packages/ai) with full AI Settings and toggleable AI Chat Sidebar (AISidebar.tsx), the guided Project Structure Tutorial Wizard (Projects.tsx), and the Admin user/role/audit management interface (AdminView.tsx). pnpm typecheck, pnpm test, pnpm lint, and pnpm build all pass across the workspace.

CHUNK #11 (Packaging, Parity & Polish) has Docker packaging (docker/compose.yaml), project template onboarding, and UI/UX polish complete.

S
Description
PubScript project
Readme GPL-3.0 1,004 KiB
Languages
TypeScript 94.2%
CSS 4.8%
C 0.4%
Shell 0.4%