Project Organization

HAI RapidUI uses a clear and logical organization for project files and directories. This structure makes it easy to understand how the application works and where to find specific resources.

Input Project Structure

When using HAI RapidUI, your input files should be organized in the input/ directory with the following structure:

input/
├── wireframes/              # [Required*] UI wireframe images
│   └── *.png
├── swagger/                 # [Optional] API specifications
│   └── *.json
├── screen_interactions/     # [Optional] UI interaction documentation
│   └── *.md
├── assets.config.json       # [Optional] Asset configurations
└── assets/                  # [Required**] Project assets
    ├── images/             # Referenced in assets.config.json
    ├── fonts/              # Font files
    └── logos/              # Logo files

File Requirements:

• * Required unless using pre-organized modules
• ** Required only if assets.config.json exists
• swagger/: Required for API integration with backend services
• screen_interactions/: Required for capturing UI interactions and routing
• assets.config.json: Required for custom images, logos, themes, and fonts

Input Project Structure after Auto Modularization

After running Auto Modularization, your input directory will be organized into modules:

input/modules/
├── authentication/
│   ├── wireframes/
│   │   ├── login.png
│   │   ├── register.png
│   │   └── forgot-password.png
│   ├── swagger.json
│   └── screen_interaction.md
├── dashboard/
│   ├── wireframes/
│   │   ├── overview.png
│   │   ├── analytics.png
│   │   └── reports.png
│   ├── swagger.json
│   └── screen_interaction.md
└── user-profile/
    ├── wireframes/
    │   ├── profile-view.png
    │   ├── profile-edit.png
    │   └── settings.png
    ├── swagger.json
    └── screen_interaction.md

Output Project Structure

When using HAI RapidUI, the generated project will be placed in the current directory with the following structure:

project-name/
├── src/                     # Generated source code
├── public/                  # Public assets
├── input/                   # Copy of input files
└── .hai-rapidui/            # Project logs and configuration
    ├── execution.log        # General execution logs
    ├── error.log            # Detailed error logs
    ├── module_state.json    # Module processing state tracking
    ├── errorhandler.json    # Error tracking and retry status
    ├── conversationhistory.json # Conversation history management
    ├── custom_instruction.md  # Custom instructions for the agent
    └── rapidui.config.json  # Project configuration