# AGENTS.md — Build guide for FlutterFlow

## Project scope
Create a small visual mobile CRUD builder with text, list, detail and form widgets. Map one approved REST schema, generate readable Flutter source and export a project that can be edited without the builder.

Catalogue verdict: kinda. The core loop is buildable, but a dependable replacement becomes a real weekend or multi-day project. For FlutterFlow, assemble a mobile interface from a schema and export maintainable Flutter code. The hard boundary is visual editor depth, native builds, integrations, collaboration, and code generation, plus connectors, runtime reliability, and governance.
Use the implementation prompt below to define the deliverable. Complete each phase's acceptance checks before extending the scope.

## Working agreement
- Inspect the repository and its existing instructions before choosing paths, dependencies or commands. Keep one coherent stack and explain changes to the proposed architecture.
- Plan a vertical slice that accepts a real input and produces the useful output described below. Persist only the state the prompt calls for; respect memory-only and upstream-managed workflows. Use fixtures only when they are clearly labelled.
- After scaffolding, document the actual install, development, check and build commands in README and keep them synchronized with the package or project manifest. Do not report commands as successful unless they ran.
- Work in small steps. At handoff, list implemented flows, checks actually performed, remaining blockers, and any credentials or provider setup the owner must supply.
- Do not publish, spend money, contact customers, delete source data or run irreversible migrations without the project owner's authorization.

## Prerequisites
- A supported Node release, a writable local data directory and a separate backup location. Bind to localhost; remote use requires authentication and HTTPS first. Flutter SDK and one user-approved REST API schema; credentials remain outside generated source.
- Implementation components: Node.js, TypeScript and Express with server-rendered HTML and small browser modules. SQLite through better-sqlite3 with migrations, prepared statements and a single background worker. A constrained widget schema and deterministic Dart source generator; a locally installed Flutter SDK checks the exported project independently.
- Scope boundary: App-store release, arbitrary Flutter plugins and full visual/source round-trip editing are separate work.

## Stack and architecture
- Node.js, TypeScript and Express with server-rendered HTML and small browser modules.
- SQLite through better-sqlite3 with migrations, prepared statements and a single background worker.
- A constrained widget schema and deterministic Dart source generator; a locally installed Flutter SDK checks the exported project independently.
- Domain model: screen trees, typed data models, widget properties, action edges and generated Dart file manifests

## Security and data integrity
- Reject unexpected origins and unbounded request bodies even on localhost. Keep credentials outside the database export and redact sensitive text from logs.
- Correctness boundary: Code generation is deterministic from the saved schema; unsupported widget/action combinations fail validation rather than producing broken source.
- Use short SQLite transactions and persist job state before starting work. Give retries stable operation IDs; report incomplete or unknown results instead of silently repeating them.
- Use a consistent SQLite backup and an attachment manifest. Export portable JSON/CSV, then restore to a new directory without overwriting the original data.

## Agent implementation rules
- Project rule — data model: screen trees, typed data models, widget properties, action edges and generated Dart file manifests
- Project rule — preserve this invariant: Code generation is deterministic from the saved schema; unsupported widget/action combinations fail validation rather than producing broken source.
- Project rule — acceptance evidence: Export a list/detail/form app, edit generated Dart manually and build it independently; a missing required API field produces a visible mapping error.

## Optional agent skills and references
- Optional external skill: [web-design-guidelines](https://github.com/vercel-labs/agent-skills/blob/main/skills/web-design-guidelines/SKILL.md) — Review web interfaces for accessibility, keyboard focus, forms, navigation and interaction quality. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission.
- Optional external skill: [sharp-edges](https://github.com/trailofbits/skills/blob/main/plugins/sharp-edges/skills/sharp-edges/SKILL.md) — Review security-sensitive APIs and configuration for dangerous defaults and easy-to-misuse interfaces. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission.

Read the linked SKILL.md and its dependencies before adding a skill. Select only the skills matching this project's runtime and task; their documentation does not supply API access, credentials or approval to perform external actions. Pin the reviewed revision where the tool supports it. Follow the chosen agent's documented project-level installation mechanism.

## Distribution ideas
These are optional planning notes. Obtain the owner's approval before publishing or contacting anyone.
- Demonstrate the actual FlutterFlow-inspired workflow with owned or clearly labeled sample data: Create a small visual mobile CRUD builder with text, list, detail and form widgets. Map one approved REST schema, generate readable Flutter source and export a project that can be edited without the builder.
- Publish a reproducible walkthrough with this observable result: Export a list/detail/form app, edit generated Dart manually and build it independently; a missing required API field produces a visible mapping error.
- Explain who can operate this scoped tool, its setup and ongoing costs, and these remaining product gaps: App-store release, arbitrary Flutter plugins and full visual/source round-trip editing are separate work. Avoid guaranteed savings, performance scores or implied endorsement.

## Engineering roadmap
1. Phase 1 — Scope and fixtures. Implement this bounded workflow: Create a small visual mobile CRUD builder with text, list, detail and form widgets. Map one approved REST schema, generate readable Flutter source and export a project that can be edited without the builder. Record prerequisites, select representative user-owned fixtures and document the unsupported features: App-store release, arbitrary Flutter plugins and full visual/source round-trip editing are separate work.
2. Phase 2 — Durable model. Model screen trees, typed data models, widget properties, action edges and generated Dart file manifests Add migrations or a versioned document format, explicit validation, stable IDs and a visible import-error report. Preserve this rule: Code generation is deterministic from the saved schema; unsupported widget/action combinations fail validation rather than producing broken source.
3. Phase 3 — Complete the first useful path. Implement the workflow's input, review and output interface, with clear controls and explicit empty/error states. Use short SQLite transactions and persist job state before starting work. Give retries stable operation IDs; report incomplete or unknown results instead of silently repeating them.
4. Phase 4 — Permissions and integration failure. Reject unexpected origins and unbounded request bodies even on localhost. Keep credentials outside the database export and redact sensitive text from logs. Request integration credentials and permissions only for the enabled feature; show a disconnected state instead of mock results.
5. Phase 5 — Portable handoff. Use a consistent SQLite backup and an attachment manifest. Export portable JSON/CSV, then restore to a new directory without overwriting the original data. Include setup, operating limits, fixture walkthrough and shutdown/restart instructions in the README.
6. Phase 6 — Acceptance scenarios. Export a list/detail/form app, edit generated Dart manually and build it independently; a missing required API field produces a visible mapping error. Repeat the workflow after restart and with a denied permission or unavailable dependency; show recoverable failure rather than a success placeholder.

## Paid-product capabilities outside this build
- visual editor depth, native builds, integrations, collaboration, and code generation
- hundreds of connectors
- pixel-perfect app design
- mobile app-store builds
- enterprise permissions and scale

## Implementation prompt
WORKING SLICE
Create a small visual mobile CRUD builder with text, list, detail and form widgets. Map one approved REST schema, generate readable Flutter source and export a project that can be edited without the builder.

Build this scoped FlutterFlow-inspired workflow with a documented data model and visible failure states.

Architecture
- Node.js, TypeScript and Express with server-rendered HTML and small browser modules.
- SQLite through better-sqlite3 with migrations, prepared statements and a single background worker.
- A constrained widget schema and deterministic Dart source generator; a locally installed Flutter SDK checks the exported project independently.

Prerequisites and limits
A supported Node release, a writable local data directory and a separate backup location. Bind to localhost; remote use requires authentication and HTTPS first. Flutter SDK and one user-approved REST API schema; credentials remain outside generated source.
Outside this release: App-store release, arbitrary Flutter plugins and full visual/source round-trip editing are separate work.

Data model and correctness
screen trees, typed data models, widget properties, action edges and generated Dart file manifests
Invariant: Code generation is deterministic from the saved schema; unsupported widget/action combinations fail validation rather than producing broken source.
Use short SQLite transactions and persist job state before starting work. Give retries stable operation IDs; report incomplete or unknown results instead of silently repeating them.

Security and privacy
Reject unexpected origins and unbounded request bodies even on localhost. Keep credentials outside the database export and redact sensitive text from logs.

Recovery and export
Use a consistent SQLite backup and an attachment manifest. Export portable JSON/CSV, then restore to a new directory without overwriting the original data.

Implementation order
1. Phase 1 — Scope and fixtures. Implement this bounded workflow: Create a small visual mobile CRUD builder with text, list, detail and form widgets. Map one approved REST schema, generate readable Flutter source and export a project that can be edited without the builder. Record prerequisites, select representative user-owned fixtures and document the unsupported features: App-store release, arbitrary Flutter plugins and full visual/source round-trip editing are separate work.
2. Phase 2 — Durable model. Model screen trees, typed data models, widget properties, action edges and generated Dart file manifests Add migrations or a versioned document format, explicit validation, stable IDs and a visible import-error report. Preserve this rule: Code generation is deterministic from the saved schema; unsupported widget/action combinations fail validation rather than producing broken source.
3. Phase 3 — Complete the first useful path. Implement the workflow's input, review and output interface, with clear controls and explicit empty/error states. Use short SQLite transactions and persist job state before starting work. Give retries stable operation IDs; report incomplete or unknown results instead of silently repeating them.
4. Phase 4 — Permissions and integration failure. Reject unexpected origins and unbounded request bodies even on localhost. Keep credentials outside the database export and redact sensitive text from logs. Request integration credentials and permissions only for the enabled feature; show a disconnected state instead of mock results.
5. Phase 5 — Portable handoff. Use a consistent SQLite backup and an attachment manifest. Export portable JSON/CSV, then restore to a new directory without overwriting the original data. Include setup, operating limits, fixture walkthrough and shutdown/restart instructions in the README.
6. Phase 6 — Acceptance scenarios. Export a list/detail/form app, edit generated Dart manually and build it independently; a missing required API field produces a visible mapping error. Repeat the workflow after restart and with a denied permission or unavailable dependency; show recoverable failure rather than a success placeholder.

Acceptance
Export a list/detail/form app, edit generated Dart manually and build it independently; a missing required API field produces a visible mapping error.
Use real source data or clearly labeled fixtures. Explain unsupported input and provider failures; do not fabricate analytics, delivery receipts, accuracy claims or security guarantees.

Optional agent guidance
Optional external skill: [web-design-guidelines](https://github.com/vercel-labs/agent-skills/blob/main/skills/web-design-guidelines/SKILL.md) — Review web interfaces for accessibility, keyboard focus, forms, navigation and interaction quality. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission.
Optional external skill: [sharp-edges](https://github.com/trailofbits/skills/blob/main/plugins/sharp-edges/skills/sharp-edges/SKILL.md) — Review security-sensitive APIs and configuration for dangerous defaults and easy-to-misuse interfaces. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission.
Project rule — data model: screen trees, typed data models, widget properties, action edges and generated Dart file manifests
Project rule — preserve this invariant: Code generation is deterministic from the saved schema; unsupported widget/action combinations fail validation rather than producing broken source.
Project rule — acceptance evidence: Export a list/detail/form app, edit generated Dart manually and build it independently; a missing required API field produces a visible mapping error.

## Completion evidence
Demonstrate the prompt's acceptance scenarios against the scoped workflow. Include setup from a clean checkout and failure recovery. Check persistence across restart and export/restore only for the state the prompt says to store; for memory-only tools, confirm that temporary content is discarded as specified. Record actual results and remaining limitations. A detailed plan alone does not establish a working replacement.
