Skip to main content
Here are practical tips and best practices for using Sonamu UI more efficiently.

Keyboard Shortcuts

Essential shortcuts for quick work:
Use search: Open search with ⌘K to quickly find Entity names, field names, etc.

Entity Management Tips

1. Structure Parent-Child Entities

Organize related Entities in parent-child relationships:
Benefits:
  • Displayed hierarchically in sidebar
  • Easy to find related Entities
  • Logical grouping

2. Consistent Naming Conventions

3. Leverage AI Chat

Writing effective prompts:
Be specific:
  • Specify field types and constraints
  • Describe relationship settings
  • Mention index requirements

4. Organize Property Order

Arrange fields in meaningful order:

Migration Tips

1. Run in Small Units Frequently

2. Use Migration Preview

Always check Preview before execution: Check items:
  • βœ… Are the columns being added correct?
  • ⚠️ Are any columns being deleted?
  • πŸ”„ Are type changes intentional?

3. Production Migration Checklist

Scaffolding Tips

1. Batch Generation Strategy

Project initial:
During development:

2. Backup Habit

Backup Models with important business logic before regeneration:

3. Utilize Git

Commit generated files immediately to manage change history:

Subset Usage Tips

1. Define Standard Subsets

Define consistent Subsets for all Entities:

2. Performance Optimization

Include only needed fields:

3. Subset Selection by API

Quick Navigation

Search (⌘K) can find:
  • Entity: User, Post
  • Fields: email, created_at
  • Migration: Filename search
  • Subset: User.Subset A
Search tips:

Workflow Optimization

New Feature Development Flow

Entity Modification Flow

Using Browser Developer Tools

Network Tab

Check API calls for debugging:

Console Tab

Check error messages:

Troubleshooting

When UI is Slow

Cause: Too many Entities or large data Solution:
  • Clear browser cache
  • Close unnecessary browser tabs
  • Restart Sonamu UI

When Changes Aren’t Reflected

Solution:
  1. Browser refresh (F5)
  2. Hard reload (βŒ˜β‡§R / Ctrl+Shift+R)
  3. Restart API server
  4. Restart Sonamu UI

Entity Save Failed

Check:
  • Is API server running?
  • Do you have file write permission?
  • Is field name valid? (reserved word check)
  • Is foreign key reference correct?

Next Steps

Entity Management

View Entity management details

Sonamu CLI

Advanced tasks via CLI