Docs · v0.10.0
Read by what you're trying to do.
The framework's surface is grouped into six intents. Pick the one that matches the question you're holding.
61 docs · 8 intents
00
Start here
What GoFastr is, how a project is laid out, and a map of every feature — the newcomer narrative before the per-feature references.
Overview
What the framework is, the two layers, and a linked map of every capability.
Tutorial: blueprint app
The thesis tutorial: one blueprint becomes a UI + API you own, in about twenty minutes.
Project structure
Start flat; grow into internal/<domain> as real boundaries appear. Structure follows the app.
Comparison
Where GoFastr sits relative to other full-stack frameworks.
Recommended pathOverview→Tutorial: blueprint app→Project structure
01
Modeling your domain
Declare entities, fields, relations. The framework generates schema, CRUD, validators, and code.
Entity declarations
JSON or Go — both produce the same tables, routes, and tools.
Filter DSL
?status=published&views_gte=10&sort=-created_at parses to a typed Where.
Cursor pagination
Keyset by EntityConfig.CursorField. Opt in by sending ?cursor=.
Eager loading
?include=author.profile flattens the N+1.
Hooks & transactions
BeforeCreate / AfterUpdate hooks share the parent tx.
Migrations
Versioned, ordered, reversible — versus the auto-migrate dev mode.
Multi-tenant scope
tenant_id column + automatic filter from request context.
Code generation
What lands on disk under gen/ — and how to read it.
Recommended pathEntity declarations→Filter DSL→Cursor pagination
02
Serving HTTP
Routes, middleware, sessions, auth, idempotency, security headers — everything between the wire and your handler.
Access control
RolePolicy, RequirePermission, custom Policy implementations.
Auth
Login, OAuth, magic-link, 2FA, password reset — each a plugin.
Idempotency
An Idempotency-Key header replays mutations safely.
API prefix & versioning
Mount the API under a prefix and evolve it across versions.
Cache
Memoize expensive reads with a pluggable backend and TTLs.
Security defaults
CSP, CSRF, rate limit, headers — all on by default.
Health checks
/healthz + /readyz with plugin checks.
Webhooks
Signed outbound delivery with retry-with-backoff.
Notifications
Multi-channel fan-out with per-channel templates.
Batch endpoints
Create / update / delete many rows in one request.
Plugins
The lifecycle every battery and feature plugs into.
Recommended pathAuth→Access control→Security defaults
03
Building UI
Server-rendered with islands. Signals, HTML primitives, composed patterns, the runtime, and theming.
Getting started (UI)
The path: scaffold → theme → screen → custom component.
New components
The minimal-register + SSR-inline + hydrate contract.
Widget builder
Build islands that hydrate against a registered handler.
Forms
Server-validated forms with island-swapped error states.
Image pipeline
Pure-Go resize + WebP lossless encode.
Runtime modules
Carved per-feature so pages without X don't ship X's JS.
Print documents
Server-rendered print-friendly documents + PDF.
Dev livereload
SSE-driven reload while you edit — zero config.
Static-site export
Render the whole app to static HTML + assets for apex or project-path hosting.
Interactive patterns
The data-fui-* vocabulary: RPC islands, signals, open-widget, optimistic actions.
Signal store
Typed, namespaced client state that fans out to many consumers from one declaration.
Recommended pathGetting started (UI)→New components→Widget builder
04
Persisting & migrating
SQLite and Postgres, dialect-aware, with the migration CLI and per-test isolation.
Audit log
WithAuditLog writes a row for every Create/Update/Delete.
Isolation
Linked git worktrees get isolated local DBs.
Testkit
Public helpers for host apps that need an isolated Postgres in integration tests.
Factories
Rails-style fixtures for tests.
Full-text search
Find records containing a term, dialect-aware.
Uploads
File + image fields with pluggable storage backends.
Env / .env
core/dotenv auto-loaded by NewApp.
Recommended pathAudit log→Isolation→Factories
05
Working with agents
MCP tools, Kiln build mode (experimental), agent permissions, plan-gated destructive ops.
Agent-readiness
Discovery surface scanners (isitagentready.com) look for: llms.txt, A2A card, MCP/OAuth well-knowns, markdown negotiation.
Kiln overview
Experimental — the agent-driven build-mode binary.
Embed
Local semantic search via brute-force cosine — no API key.
Agent notes
Append-only review log for agents working on the framework.
Audit deps
Detect packages an agent shouldn't import.
Blueprints
Reusable bundles of entities + screens an agent can apply.
Recommended pathAgent-readiness→Kiln overview→Embed→Agent notes
06
Operations
Run it in production. Logging, metrics, feature flags, env, i18n.
Logging
Structured JSON logs with MCP query tools.
Observability
Metrics and tracing for the hot paths.
Deployment
Ship it: build, configure, and run GoFastr in production.
Job queue
Durable background jobs via battery/queue.
Feature flags
Rollout percentage, allow lists, env evaluator.
i18n
JSON catalogs, plurals, Accept-Language negotiation.
Cron
Scheduled jobs with retry + jitter.
Events
In-process pub/sub for decoupled side effects.
Admin UI
An opt-in listing + form per entity.
Recommended pathLogging→Feature flags→i18n
07
Reference & internals
Performance numbers and the deeper design + tooling docs — surfaced so nothing is hidden.
Benchmarks
What's measured, how, and the methodology behind the numbers.
Performance results
Latest throughput / latency results across the hot paths.
Harness architecture
The AI coding-harness design (contributor/internal reference).
Harness E2E testing
How the harness drives end-to-end browser tests.
Architecture review
The revalidated risk register + maintenance rules.
Recommended pathBenchmarks→Performance results
∑
Every doc · A–Z
The complete embedded reference — every page, alphabetical, featured or not. Same content as `gofastr docs`.
Access control
Admin UI
Agent Notes
Agent-readiness
API prefix & versioning
Auditing init-time global registrations
Audit log
Authentication
Batch endpoints
Benchmarks
Blueprints
Cache
Codegen
Comparison — where GoFastr sits
Cron / scheduled jobs
Cursor pagination
Deployment
Dev-mode livereload
.env files
Embed — local semantic search
Entity Declarations
Entity events & SSE
Factories / fixtures
Feature flags
Form Module
GoFastr harness architecture
Harness end-to-end testing
Health and readiness
Hooks & transactions
Internationalization
Idempotency keys
Image pipeline
Includes & eager loading
Interactive patterns
Worktree isolation
Kiln — agent-driven build mode
Server logs (`battery/log`)
Migrations
Multi-tenant scoping
Unified notifications
Observability (metrics & tracing)
Overview — what GoFastr is, and everything it does
§7 Performance verification — 2026-05-31
Plugins
Printable documents
GoFastr Current Risk Register
Project structure
Query DSL
Job queue (`battery/queue`)
Runtime JS minification
Search
Security defaults
Signal store (shared client state)
Static-site export
Testkit — isolated Postgres helpers for integration tests
Tutorial: one blueprint → UI + API you own
UI getting started
UI components — index
File uploads
Outbound webhooks
Widgets — `core-ui/widget`