FolioMind

FolioMind helps students, researchers and independent publishers organize documents, understand their contents, compare sources and create polished PDFs. Readers upload course material, ask questions with page citations, combine several sources in a research workspace, approve an outline, edit an AI generated draft and export a report. Publishers can submit authorized books for a moderated public catalog.

Repository layout

Path	Contents
apps/web	Next.js application
apps/worker-ingestion	Worker A: ingestion, web import, notifications, billing sync, cleanup
apps/worker-generation	Worker B: outline/draft generation and PDF export
packages/*	Shared @foliomind/* packages: db, domain, contracts, ai, pdf, workflows
infra	Dockerfiles and the local Docker Compose stack
scripts	Cross-platform TypeScript scripts (run with tsx)
docs/setup	Setup guides for accounts, keys and local services

Prerequisites

• Node.js 24 LTS (.nvmrc); at least 20.9
• pnpm through Corepack (corepack enable pnpm; the version is pinned in package.json)
• Docker Desktop for the local service stack and image builds

Getting started

pnpm install
cp apps/web/.env.example apps/web/.env.local
cp apps/worker-ingestion/.env.example apps/worker-ingestion/.env
cp apps/worker-generation/.env.example apps/worker-generation/.env
cp infra/.env.example infra/.env
pnpm stack:up          # Postgres, Redis + Upstash proxy, Inngest Dev Server, Browserless
pnpm dev               # http://localhost:3000, both workers, Inngest UI at http://localhost:8288
pnpm check:services    # smoke checks

The defaults work without any third-party keys; services without keys report "not configured". Add keys as described in docs/setup/third-party-services.md.

While pnpm dev runs, http://localhost:3000/dev/ui shows every UI component in its empty, loading, sample and error states, with previews of the signed-in screens. It is development-only and returns 404 in production builds. Signed-in e2e tests need E2E_STORAGE_STATE pointing to a Playwright storage state saved after signing in; without it they are skipped.

Commands

Command	What it does
pnpm install	Install all workspaces
pnpm dev	Run the web app (http://localhost:3000) and both workers
pnpm build	Build every app
pnpm lint / pnpm typecheck / pnpm test	Quality checks across the monorepo
pnpm e2e	Playwright end-to-end tests (first run: pnpm --filter web exec playwright install chromium, or set PLAYWRIGHT_CHANNEL=chrome to use an installed Google Chrome)
pnpm format / pnpm format:check	Prettier
pnpm stack:up / stack:down	Start or stop the local Docker services
pnpm check:services	Connectivity smoke checks for every service (--only=postgres,upstash,…)
pnpm db:generate / db:migrate / db:studio	Drizzle migrations (see docs/setup/database.md)
pnpm db:setup	Migrate, create the runtime role and seed plans and categories (local Compose database by default)
pnpm db:roles / db:seed / db:seed:dev	Runtime role grants; required seed; sample catalog (local only)
pnpm stack:migrate	The same database setup in the one-shot migrate container
pnpm promote-admin <email>	Grant admin to an existing account, with an audit entry