Site ↗
Documentation sections
UI interface · 0.8.1

Generator UI: finding the right setting

Screen map and workflow: edit the model, save it, preview results and Generate.

On this page

Generator UI describes your application: create entities, add fields, connect records and configure access. Preview changes and Generate here too. The editor saves the declarative model itself; everyday work does not require opening YAML.

Generator UI and the generated admin are separate applications. In the generator, change structure and generate code. In the admin, manage data: articles, users and images. Changing a record requires no Generate.

Generator screens

Screen When to open Detailed guide
Dashboard Check the project and choose the next step. Dashboard
Project settings Set title and image storage. Project settings
Deployment Select Docker, CI, delivery and environments. Deployment
Content Build the model: modules, entities, fields and relationships. Content overview
Generate Review plan/diff, resolve conflicts and generate files. Generation
History Find a previous run's result. History

Content: choose a task

Task Article
Create a persistent entity or change its settings. Entities
Add a field; choose type, constraints, presentation and List behavior. Fields
Configure CRUD, external access and mandatory conditions; inspect routes. Entity access
Connect records and configure foreign keys. Relationships
Build a response from selected fields and related collections. Virtual entities
Configure Image/Gallery and variants. Images

Start with the knowledge-base example, from an empty project to a working model. Article → Section and tags are explained in relationship practice.

Applying model changes to the application

  1. Open the required setting and edit it.
  2. Click Finish to save the model, without changing the running application or PostgreSQL data.
  3. Open Generate → Preview changes and inspect the plan/file changes.
  4. Generate, apply necessary migrations and start the updated application using local development instructions.

Saving, cancelling and messages

Finish saves changes and closes the editor. Cancel or closing the form discards an unsaved draft. Deletion is separate: it does not save other form edits.

If someone changes the model concurrently, the editor will not overwrite it with stale state. Refresh, compare with your draft and repeat the needed change. Do the same for an uncertain result: check first so repeated Create does not add a duplicate.

Model, application files and database data change through different actions. Saving a setting does not update the running application. See Generate and recovery.

Optional: CLI interface

Use CLI for scripts or repeatable changes to the same model. UI is sufficient for daily editing. Process startup and application maintenance are separate; see operations guides.