README
¶
GoFastr examples
Two kinds of example live here.
Go examples (runnable)
Self-contained Go programs — go run ./examples/<name>:
| Example | What it shows |
|---|---|
blog |
Entities in Go + custom endpoints + full-text search; the canonical starter. |
api-tour |
The v2 REST API: includes, cursor pagination, batch, SSE. |
backoffice |
The entity admin (battery/admin) behind a demo login. |
spa |
Client-side navigation over server-rendered islands. |
static-site |
Static page serving with the file server. |
embed-demo |
Semantic search with battery/embed. |
Blueprint examples (declarative)
These are gofastr.yml blueprints — no Go. They describe a whole app
(entities, screens, nav, seed) declaratively. Generate a runnable project
from one with:
cd examples/ecommerce && gofastr generate --from=gofastr.yml
| Blueprint | Domain |
|---|---|
ecommerce |
The flagship. A complete storefront — 5 related entities, themed UI, custom endpoints, seed data — declared once in gofastr.yml and emitted as runnable Go. Ships secure-by-default: auth enabled plus owner-scoped orders / order_items. See ecommerce/README.md and its BUILD_JOURNAL.md; flagship_test.go regenerates and boots it end-to-end. |
lms |
Courses, lessons, enrollments. |
portfolio |
Projects + case studies. |
project-manager |
Projects, tasks, teams. |
real-estate |
Listings, agents, inquiries. |
Every blueprint here is validated by TestExampleBlueprintsLoad
(cmd/gofastr), so a broken one fails CI.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package main is a tour of the v2 API surface added to the framework:
|
Package main is a tour of the v2 API surface added to the framework: |
|
Command backoffice is a minimal example of the battery/admin entity CRUD admin rendered through a UI host: a few entities, a (demo-grade) login, and admin.New(...) generating the whole back-office with defaults.
|
Command backoffice is a minimal example of the battery/admin entity CRUD admin rendered through a UI host: a few entities, a (demo-grade) login, and admin.New(...) generating the whole back-office with defaults. |
|
Package ecommerce is GoFastr's declaration-driven flagship example: a complete storefront — five related entities, screens, navigation, custom endpoints, seed data, and a theme — declared once in gofastr.yml and emitted as runnable Go by the CLI:
|
Package ecommerce is GoFastr's declaration-driven flagship example: a complete storefront — five related entities, screens, navigation, custom endpoints, seed data, and a theme — declared once in gofastr.yml and emitted as runnable Go by the CLI: |
|
Package main is a minimal demonstration of the battery/embed package.
|
Package main is a minimal demonstration of the battery/embed package. |
Click to show internal directories.
Click to hide internal directories.