Erlyc Erlyc

Entities tab

What this screen does

The Entities tab is a diagram of your domain: each box is an entity (Customer, Order, Invoice), each row inside it an attribute, and each curve between boxes a relationship. Everything downstream — tables, models, generated code — derives from this diagram, so it is the most important surface to get right.

Typical workflow

  1. Review the seeded diagram. Click an entity to select it; double-click to edit its name and description.
  2. Add Entity creates a new box; Add Attribute adds a field to the selected entity — set its type, options, and whether it is nullable or unique.
  3. Draw relationships between entities and pick the right kind (one-to-many, many-to-many, one-to-one).
  4. Keep the canvas readable: Realign tidies the layout, Fit All zooms to show everything, and snap-to-grid keeps boxes aligned as you drag.
  5. Use Text View for a compact, reviewable listing of every entity and attribute, and Import/Export Entities JSON to move a diagram between projects or back it up.

Examples & tips

  • Model real-world things, not screens. "Appointment" is an entity; "Booking form" is not.
  • Attribute descriptions carry into the generated code and demo data — a sentence on what "status" means saves guesswork later.
  • Selecting an entity highlights its related entities, which is the quickest way to spot a missing or inverted relationship.
  • Deleting an entity removes its relationships too; export a JSON backup before big restructuring.