Skip to main content
Sonamu UI is a web-based development tool for managing Entities, Migrations, Scaffolding, and Fixtures. You can perform tasks that were done via CLI with a more intuitive visual interface, and it also provides test result viewing and CDD contract management features.

​
What is Sonamu UI?

Sonamu UI provides the following features:

​
How to Run

​
Running in Development Environment

Sonamu UI is built into the API server. No separate command is needed.
When the API server starts, Sonamu UI is automatically served alongside it. Default URL: http://localhost:34900/sonamu-ui
Sonamu UI is served at the /sonamu-ui path of the API server without a separate port.

​
Typical Development Workflow

​
Interface Structure

Sonamu UI Full Screen

Sonamu UI Full Screen

Sonamu UI consists of three main areas:

​
1. Global Navigation Bar (GNB)

Located at the top of the screen for quick access to main features.

​
2. Sidebar

Located on the left side, displays the item list for the currently selected menu.
  • Entities tab: Display all Entity list
  • Migrations tab: Migration file list
  • Bottom button: Add new item button (e.g., New Entity)

​
3. Main Content Area

The wide area in the center where you view and edit details of selected items.
  • Edit Entity properties
  • Preview migrations
  • Code generation options, etc.

​
Keyboard Shortcuts

​
Next Steps

Entity Management

Create and edit Entities

Scaffolding

Auto-generate code

Tasks

Monitor workflows