Guides

New to Beignet? Start with the quickstart, then build the Projects tutorial. Use Mental model for the framework's vocabulary and API reference for exported types and functions.

Build a feature

• Protect a resource — derive ownership from the signed-in account, enforce access in use cases, and test two users. Continues the Projects API chapter.
• Connect forms and lists — create, edit, and paginate Projects through a typed client, with shared validation and cache refreshes. Continues the ownership chapter.
• Upload a file — generate an upload workflow, configure storage and its route, and connect the browser client.

Add background work and communication

• Run a background job — save a job with a new project, deliver it through an outbox drain, and test retries and rollback. Uses the completed Projects app and SQLite.
• Send an email — configure a mail provider, send through the app's mail port, and test delivery with an in-memory mailer.
• Run work on a schedule — define a scheduled operation and connect the runtime that will invoke it.

Ship and operate

• Prepare an app for production — check migrations, environment variables, readiness, and the services your app depends on.
• Deploy workers and drains — choose explicit entrypoints for queue workers and outbox delivery alongside your web app.
• Recover a failed job — inspect a dispatch receipt and retry eligible work through its configured provider.

Use a guide with your agent

Open the guide you need and use Copy page near its title, or choose Open Markdown from its menu, to share the instructions and code. Give your agent the behavior you want and the app's local instructions, then review the guide's expected result together.

The agent instructions explain how to select guidance for the installed version, inspect the app, and verify a change. The background job guide includes a prompt with concrete completion checks.