# Flourish UI

> Flourish UI is an open-source collection of 50+ expressive, interactive React components with live previews, WebGL shaders, tactile skeuomorphism, motion physics, and shadcn CLI registry support.

## Core Documentation & Resources
- [Official Website](https://flourish-ui.vercel.app): Live interactive showcase of 50+ React components.
- [Components Catalog](https://flourish-ui.vercel.app/components): Complete searchable library with live previews and filters.
- [Developer Portal](https://flourish-ui.vercel.app/developers): Documentation, REST API endpoints, and integration guides.
- [OpenAPI Specification](https://flourish-ui.vercel.app/openapi.json): Full machine-readable REST API schema in OpenAPI 3.1 format.
- [shadcn Registry Index](https://flourish-ui.vercel.app/r/registry.json): Registry catalog for direct shadcn CLI installation.
- [Machine-Readable Pricing](https://flourish-ui.vercel.app/pricing.md): Open-source MIT license and free usage declaration.
- [Full LLM Knowledge Bundle](https://flourish-ui.vercel.app/llms-full.txt): Complete multi-component code and documentation bundle.
- [Open Knowledge Format Index](https://flourish-ui.vercel.app/okf/index.md): Modular OKF directory for AI crawlers and agents.
- [Agent Autonomy Guidance](https://flourish-ui.vercel.app/AGENTS.md): Detailed instruction set for autonomous agents.
- [GitHub Repository](https://github.com/Zuhaib-dev/Flourish-UI): Open source repository, issue tracker, and discussions.

## Public REST API Endpoints
All endpoints return JSON with full CORS permissions:
- `GET https://flourish-ui.vercel.app/api/components`: List all components with pagination and filtering (`?category=...`, `?search=...`, `?tag=...`, `?limit=...`, `?offset=...`).
- `GET https://flourish-ui.vercel.app/api/components/{slug}`: Fetch detailed component metadata, dependencies, and install commands.
- `GET https://flourish-ui.vercel.app/api/components/{slug}/source`: Download raw TypeScript/React source code for direct codebase injection.
- `GET https://flourish-ui.vercel.app/api/categories`: List all component design categories and counts.

## WebMCP (Browser Agent In-Page Tools)
Flourish UI implements the WebMCP standard for autonomous browser agents via `document.modelContext.registerTool()` and `navigator.modelContext`:
- `search_components`: Search components by query or category.
- `get_component`: Retrieve metadata and install commands by slug.
- `get_component_source`: Fetch raw component TypeScript source.
- `list_categories`: List all categories.
- `get_install_command`: Generate shadcn CLI command for pnpm, npm, bun, or yarn.

## shadcn CLI Integration
Install any component directly into a Next.js / React project:
```bash
# Example: Liquid Glass Folder Stack
pnpm dlx shadcn@latest add https://flourish-ui.vercel.app/r/liquid-glass-folder-stack.json

# Example: Raster Dynamics Wordmark
pnpm dlx shadcn@latest add https://flourish-ui.vercel.app/r/raster-dynamics-wordmark.json
```
Components land in `components/flourish/` with zero vendor lock-in.

## Optional Information
- [Agent Guidance](https://flourish-ui.vercel.app/AGENTS.md): Best practices for selecting and assembling tactile components.
- [License and Terms](https://flourish-ui.vercel.app/pricing.md): 100% Free under the MIT License for personal and commercial usage.