README.md

# UiPlus: Creative Web UI Dataset

**UiPlus** is a dataset designed for training machine learning models to generate creative web UI designs, with a focus on modern web components and Sinhala-specific user interfaces. It contains HTML code snippets, design descriptions, and metadata for UI components like product cards, navbars, and more, primarily built with Tailwind CSS. The dataset is tailored for e-commerce, modern, and minimalist UI styles, with support for Sinhala typography and accessibility features.

## Dataset Description
- **Purpose**: To enable the training of text-to-UI generation models that can produce modern, responsive, and accessible web UI components, with a focus on Sinhala e-commerce and cultural context.
- **Current Size**: 2 UI components (product card, navbar), with plans to expand.
- **Language**: English and Sinhala (bilingual descriptions).
- **Framework**: Tailwind CSS.
- **License**: MIT License (see [LICENSE](./LICENSE)).

## Dataset Structure
The dataset is stored in a JSON file (`data.json`) with the following fields for each UI component:

| Field                | Type         | Description                                                                 |
|----------------------|--------------|-----------------------------------------------------------------------------|
| `id`                | String       | Unique identifier for the UI component (e.g., "ui_sinhala_001").            |
| `description`       | String       | English description of the UI design (e.g., "Modern e-commerce product card"). |
| `sinhala_description` | String     | Sinhala description of the UI design (e.g., "පැස්ටල් වර්ණ සහිත නිෂ්පාදන කාඩ්"). |
| `html`              | String       | HTML code snippet for the UI component, using Tailwind CSS classes.         |
| `framework`         | String       | CSS framework used (e.g., "Tailwind CSS").                                  |
| `color_scheme`      | List[String] | List of hex color codes used in the UI (e.g., ["#FBCFE8", "#FFFFFF"]).      |
| `category`          | String       | UI style or category (e.g., "e-commerce", "modern", "minimalist").          |
| `responsive`        | Boolean      | Whether the UI is responsive (true/false).                                  |
| `accessibility`      | List[String] | Accessibility features (e.g., ["ARIA labels", "High-contrast text"]).       |
| `image_path`        | String       | Path to the UI screenshot (e.g., "screenshots/ui_sinhala_001.png").        |
| `sinhala_font`      | String       | Sinhala font used (e.g., "Noto Sans Sinhala").                             |

### Example Entry
```json

{

  "id": "ui_sinhala_001",

  "description": "Modern e-commerce product card with pastel colors and hover effects",

  "sinhala_description": "පැස්ටල් වර්ණ සහ hover effects සහිත නවීන e-commerce නිෂ්පාදන කාඩ් එකක්",

  "html": "<div class='bg-white p-6 rounded-lg shadow-md hover:shadow-xl transition duration-300'><img src='product.jpg' alt='Product' class='w-full h-48 object-cover rounded'><h3 class='text-lg font-semibold mt-4'>නිෂ්පාදනය</h3><p class='text-gray-600'>රු. 2500</p><button class='mt-4 bg-pink-400 text-white px-4 py-2 rounded hover:bg-pink-500' aria-label='Add to cart'>කරත්තයට එකතු කරන්න</button></div>",

  "framework": "Tailwind CSS",

  "color_scheme": ["#FBCFE8", "#FFFFFF", "#4B5563"],

  "category": "e-commerce",

  "responsive": true,

  "accessibility": ["ARIA labels", "High-contrast text"],

  "image_path": "screenshots/ui_sinhala_001.png",

  "sinhala_font": "Noto Sans Sinhala"

}