User Interface : Overview
The Scaffolder.net User Interface is organized around four main components that form your solution architecture, presented in a hierarchical relationship : Solutions -> Bounded Contexts -> Entities -> Entity properties.
Typical workflow
The typical workflow for using the Scaffolder.net User Interface involves the following steps :
- Create a Solution (Name your Solution)
- Add Bounded Contexts (Create one or more bounded contexts for business domains)
- Add Entities (Within each context, create entities representing business objects)
- Define Entity properties (For each entity, define its properties with types and constraints)
- Review and Download (Review the generated files, database schema and download the complete solution)
CRUD operations
All four main components support standard CRUD (Create, Read, Update, Delete) operations :
- Create : Add new Solutions, Bounded Contexts, Entities or Entity properties
- Read : View lists (with paging, sorting, and filtering) and details of all components
- Update : Edit existing components
- Delete : Remove existing components (requires confirmation)
Warning : Deleting a component (like a Bounded context) will also delete all child components (Entities and their properties).
Dialogs and forms
Creating, editing, and deleting items use modal dialogs :
- Click buttons (Add, Edit, Delete) to open dialog
- Fill in required fields depending on the operation
- Click buttons (Create, Save, Delete, Cancel) to perform the action
- If an error occurs, a message will be displayed using a notification system
Navigation
Navigate through the User Interface using :
- Main Menu : Access Home and Solutions pages
- Breadcrumbs : Shows your current location and allows quick navigation
- List Views : Tables showing all items at the current level
- Details View : Shows detailed information and child items
Viewing generated files
Before downloading your solution :
- Navigate to a Solution details page
- Click "View Files" button
- See complete file structure that will be created
- Each file shows its content and location in the project hierarchy
Viewing database and objects schema
Once your solution structure is defined :
- Navigate to a Bounded context details page
- At the bottom of the page you will see a "Schema" section
- Review the complete database schema and object relationships
Downloading solutions
Once your solution structure is defined :
- Navigate to a Solution details page
- Click "Download Solution" button
- Browser downloads a .zip file with your complete solution
- Extract the zip file
- Open the .sln file in Visual Studio
Tips and best practices
Here are some tips and best practices for using the Scaffolder.net User Interface effectively :
- Plan your Bounded contexts : Think about domain separation before creating Bounded contexts
- Meaningful names : Use clear, descriptive names for Bounded contexts, Entities and their properties
- Properties first : Define Entities and their properties carefully, changes require regeneration
- Test before Download : Use the file preview and the database schema to verify structure
- Version control : Add generated solutions to Git immediately to track changes between versions
- Iterative approach : Create simple structures first, then refine