### Setup Development Environment for KERN UX-Standard Theme Source: https://github.com/public-ui/kolibri/blob/develop/packages/themes/kern/CONTRIBUTING.en.md Clone the repository, install dependencies, install Playwright browsers, and start the development server. The start command enables continuous theme rebuilding while inspecting styles in a sample application. ```bash # Clone repository git clone https://gitlab.opencode.de/kern-ux/kern-developer-kit.git cd kern-developer-kit # Install dependencies npm install # Install Playwright browsers npx playwright install # Start development (theme watch & sample app) npm start ``` -------------------------------- ### Install and Run KoliBri React Sample App Source: https://github.com/public-ui/kolibri/blob/develop/packages/samples/react/README.md Follow these steps to clone the repository, install dependencies, build the project, and start the development server for the React sample app. ```bash git clone git@github.com:public-ui/kolibri.git cd kolibri pnpm install pnpm -r build cd packages/samples/react pnpm start ``` -------------------------------- ### Local Development Setup for KoliBri Source: https://github.com/public-ui/kolibri/blob/develop/docs/arc42/07-deployment-view.md Steps to set up the KoliBri development environment locally, including cloning the repository, installing Node.js and pnpm, installing dependencies, building packages, and starting the development server for a React sample application. ```bash # Clone repository git clone https://github.com/public-ui/kolibri.git cd kolibri # Install Node.js 22 # (platform-specific installation) # Enable pnpm corepack enable pnpm # Install dependencies pnpm i --ignore-scripts # Build all packages pnpm -r build # Start development server cd packages/samples/react pnpm start ``` -------------------------------- ### Install and Run KoliBri Presentation App Source: https://github.com/public-ui/kolibri/blob/develop/packages/samples/presentation/README.md Steps to install dependencies, build the project, and start the presentation app locally. Assumes you are in the repository root. ```powershell pnpm i --ignore-scripts pnpm -r build cd packages/samples/presentation pnpm prepare:components; pnpm prepare:themes pnpm start ``` -------------------------------- ### Build and Install Dependencies Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/hydrate-server/CONTRIBUTING.md Before testing, build the package and install its dependencies. ```bash pnpm build pnpm install ``` -------------------------------- ### Install Dependencies and Build Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/mcp/README.md Commands to install dependencies, generate sample index, and build the project. ```bash pnpm install pnpm generate-index pnpm build ``` -------------------------------- ### Install KoliBri Solid Adapter Source: https://github.com/public-ui/kolibri/blob/develop/packages/adapters/solid/README.md Install the adapter using npm, pnpm, or yarn. ```bash npm i @public-ui/solid pnpm i @public-ui/solid yarn add @public-ui/solid ``` -------------------------------- ### Run Local MCP Server Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/mcp/README.md After local installation, run the MCP server using the 'kolibri-mcp' command. This starts a local instance for use with MCP clients. ```bash kolibri-mcp ``` -------------------------------- ### Vercel Deployment Quick Start Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/mcp/README.md Quick start commands for deploying the package to Vercel as a serverless API. ```bash pnpm run generate-index pnpm run build vercel --prod ``` -------------------------------- ### Install KoliBri Hydrate-Adapter Source: https://github.com/public-ui/kolibri/blob/develop/packages/adapters/hydrate/README.md Install the adapter using your preferred package manager. ```bash npm i @public-ui/hydrate pnpm i @public-ui/hydrate yarn add @public-ui/hydrate ``` -------------------------------- ### Install KoliBri Svelte Adapter Source: https://github.com/public-ui/kolibri/blob/develop/packages/adapters/svelte/README.md Install the adapter using npm, pnpm, or yarn. ```bash npm i @public-ui/svelte pnpm i @public-ui/svelte yarn add @public-ui/svelte ``` -------------------------------- ### Start Local MCP Client (stdio) Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/mcp/AGENTS.md Use these commands to start the Kolibri MCP agent for local clients via the stdio transport. This can be done via npm scripts, directly executing the Node.js script, or using the globally installed bin. ```bash # Via npm script pnpm start:stdio # Or directly node dist/cli.cjs # Or via bin (after npm install -g) kolibri-mcp ``` -------------------------------- ### Install KoliBri Angular Adapter Source: https://github.com/public-ui/kolibri/blob/develop/packages/adapters/angular/v19/README.md Install the adapter using npm or pnpm. ```bash npm install @public-ui/angular-v19 pnpm add @public-ui/angular-v19 ``` -------------------------------- ### Install KoliBri Preact Adapter Source: https://github.com/public-ui/kolibri/blob/develop/packages/adapters/preact/README.md Install the Preact adapter using npm or pnpm. ```bash npm install @public-ui/preact pnpm add @public-ui/preact ``` -------------------------------- ### Install Default Theme and Register Components Source: https://github.com/public-ui/kolibri/blob/develop/README.md Installs the default theme and registers Kolibri components with the application. Ensure these packages are installed before running this code. ```bash pnpm add @public-ui/components @public-ui/theme-default ``` ```typescript import { register } from '@public-ui/components'; import { defineCustomElements } from '@public-ui/components/loader'; import { DEFAULT } from '@public-ui/theme-default'; register(DEFAULT, defineCustomElements); ``` -------------------------------- ### Start Development Server for Components Source: https://github.com/public-ui/kolibri/blob/develop/CONTRIBUTING.md Navigates to the components package and starts the development server. This is used for actively developing the UI components. ```shell cd packages/components/ pnpm dev ``` -------------------------------- ### Create MCP Production Build and Start Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/mcp/AGENTS.md Execute these commands sequentially to create a production build of the MCP package and then start the production server. ```bash pnpm --filter @public-ui/mcp build pnpm --filter @public-ui/mcp start ``` -------------------------------- ### Install KoliBri Vue Adapter Source: https://github.com/public-ui/kolibri/blob/develop/packages/adapters/vue/README.md Install the Vue adapter using npm, pnpm, or yarn. ```bash npm i @public-ui/vue pnpm i @public-ui/vue yarn add @public-ui/vue ``` -------------------------------- ### Install @public-ui/icons with yarn Source: https://github.com/public-ui/kolibri/blob/develop/packages/ecl-icons/README.md Install the icon font package using yarn. ```bash yarn add @public-ui/icons ``` -------------------------------- ### Fetch Tool Log Examples Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/mcp/docs/LOGGING.md These examples show the log output for the 'fetch' tool, illustrating calls and completions. ```text [2025-11-06T09:45:24.123Z] [TOOL] fetch called { "id": "sample/button/basic" } [2025-11-06T09:45:24.145Z] [TOOL] fetch completed { "id": "sample/button/basic", "kind": "sample" } ``` -------------------------------- ### Clone and Setup ECL Theme Repository Source: https://github.com/public-ui/kolibri/blob/develop/packages/themes/ecl/README.md Clone the Public UI Kolibri repository and navigate to the ECL theme directory for local setup. ```bash git clone https://github.com//kolibri.git cd kolibri/lib/packages/themes/ecl ``` -------------------------------- ### Install React Hook Form Adapter Source: https://github.com/public-ui/kolibri/blob/develop/packages/adapters/react-hook-form-adapter/README.md Install the package using npm. ```bash npm i @public-ui/react-hook-form-adapter ``` -------------------------------- ### Install KoliBri Components Source: https://github.com/public-ui/kolibri/blob/develop/packages/components/src/components/README.md Install the KoliBri components package using npm, pnpm, or yarn. ```bash npm i @public-ui/components pnpm i @public-ui/components yarn add @public-ui/components ``` -------------------------------- ### Start Local Server for Icon Preview Source: https://github.com/public-ui/kolibri/blob/develop/packages/ecl-icons/AGENTS.md Starts a local server to preview all icons. Open http://localhost:3000 in your browser to see the icon catalog. ```bash # From monorepo root pnpm --filter @public-ui/icons start # Or from this directory pnpm start ``` -------------------------------- ### Install @public-ui/icons with npm Source: https://github.com/public-ui/kolibri/blob/develop/packages/ecl-icons/README.md Install the icon font package using npm. ```bash npm install @public-ui/icons ``` -------------------------------- ### Install @public-ui/icons with pnpm Source: https://github.com/public-ui/kolibri/blob/develop/packages/ecl-icons/README.md Install the icon font package using pnpm. ```bash pnpm add @public-ui/icons ``` -------------------------------- ### Install and Build Monorepo Dependencies Source: https://github.com/public-ui/kolibri/blob/develop/packages/themes/ecl/README.md Install all dependencies for the monorepo and build the project, including the ECL theme. ```bash pnpm i pnpm build ``` -------------------------------- ### Install Kolibri CLI and Run Migration Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/kolibri-cli/README.md Install the specified version of the Kolibri CLI globally and then run the migration process for a given project path. After migration, format the changed files and review the differences. ```bash pnpm i -g @public-ui/kolibri-cli@2 # install the CLI matching the next version kolibri migrate path/to/project # run all tasks for the upgrade pnpm format # format changed files git diff # review results and commit ``` -------------------------------- ### Install KoliBri Hydrate Server Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/hydrate-server/README.md Install the KoliBri Hydrate Server package using pnpm. ```bash pnpm add @public-ui/hydrate-server ``` -------------------------------- ### Install Stylelint Rules Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/stylelint-rules/README.md Install the custom Stylelint rules package using npm or pnpm. ```bash npm i -D @public-ui/stylelint-rules pnpm i -D @public-ui/stylelint-rules # recommended ``` -------------------------------- ### Search Tool Log Examples Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/mcp/docs/LOGGING.md These examples demonstrate the log output for the 'search' tool, including when it's called and completed. ```text [2025-11-06T09:45:23.456Z] [TOOL] search called { "query": "button", "kind": "sample", "limit": 10 } [2025-11-06T09:45:23.478Z] [TOOL] search completed { "query": "button", "resultCount": 5, "options": { "limit": 10, "kind": "sample" } } ``` -------------------------------- ### Install KoliBri Components and Default Theme Source: https://github.com/public-ui/kolibri/blob/develop/docs/HOWTO_REGISTER_COMPONENTS_AND_THEMES.md Install the core component bundle and the default theme package using pnpm. Replace `@public-ui/theme-default` with other theme packages if needed. ```bash pnpm add @public-ui/components @public-ui/theme-default ``` -------------------------------- ### Install KoliBri Themes Source: https://github.com/public-ui/kolibri/blob/develop/packages/themes/README.md Install the KoliBri themes package using npm, pnpm, or yarn. ```bash npm i @public-ui/themes pnpm i @public-ui/themes yarn add @public-ui/themes ``` -------------------------------- ### Install KoliBri React Adapter Source: https://github.com/public-ui/kolibri/blob/develop/packages/adapters/react/README.md Install the adapter using npm, pnpm, or yarn. This command adds the necessary package to your project's dependencies. ```bash npm i @public-ui/react pnpm i @public-ui/react yarn add @public-ui/react ``` -------------------------------- ### Install Default Theme and Components Source: https://github.com/public-ui/kolibri/blob/develop/packages/themes/default/README.md Install the default theme and components packages using npm. This is the first step to integrate the Public UI library into your project. ```bash npm install @public-ui/components @public-ui/theme-default ``` -------------------------------- ### Install KoliBri CLI Tools Globally Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/kolibri-cli/README.md Install the KoliBri CLI Tools globally using npm, pnpm, or yarn. Ensure you install the exact version you intend to upgrade to, as the migration tool uses this to determine necessary migration tasks. ```bash npm i -g @public-ui/kolibri-cli ``` ```bash pnpm i -g @public-ui/kolibri-cli ``` ```bash yarn add -g @public-ui/kolibri-cli ``` -------------------------------- ### Error Log Example Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/mcp/docs/LOGGING.md This example demonstrates the log output for an error condition, specifically when a fetch entry is not found. ```text [2025-11-06T09:45:25.789Z] [ERROR] fetch failed: entry not found { "id": "non-existent-id" } ``` -------------------------------- ### Install KoliBri Angular Adapter Source: https://github.com/public-ui/kolibri/blob/develop/packages/adapters/angular/v21/README.md Install the KoliBri Angular v21 adapter using npm or pnpm. ```bash npm install @public-ui/angular-v21 pnpm add @public-ui/angular-v21 ``` -------------------------------- ### Kolibri Migration Configuration Example Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/kolibri-cli/README.md Example configuration for the .kolibri.config.json file, showing how to enable or disable specific migration tasks. Setting a task to 'true' enables it, while 'false' disables it. ```json { "migrate": { "tasks": { ".gitignore-add-rule-.kolibri.migrate.json": true, } } } ``` -------------------------------- ### Install KoliBri Components Source: https://github.com/public-ui/kolibri/blob/develop/docs/HOWTO_ICON_FONTS.md Install the @public-ui/components package which includes the KolIcons font files. This is a prerequisite for using the icons. ```bash pnpm add @public-ui/components # or npm install @public-ui/components ``` -------------------------------- ### Install KoliBri Visual Tests Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/visual-tests/README.md Install the KoliBri Visual Tests package using npm, pnpm, or yarn. ```bash npm i -D @public-ui/visual-tests pnpm i -D @public-ui/visual-tests # recommended yarn add -D @public-ui/visual-tests ``` -------------------------------- ### Install KERN UX Theme and KoliBri Components Source: https://github.com/public-ui/kolibri/blob/develop/packages/themes/kern/README.en.md Install the necessary packages for the KERN UX theme and KoliBri components using npm. ```bash npm install @kern-ux-public-ui/theme-kolibri @public-ui/components ``` -------------------------------- ### Install ECL Theme and Components Source: https://github.com/public-ui/kolibri/blob/develop/packages/themes/ecl/README.md Install the necessary packages for the ECL Theme and Public UI components using npm. ```bash npm install @public-ui/components @public-ui/theme-ecl ``` -------------------------------- ### Install and Run MCP Inspector Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/mcp/README.md Installs the MCP Inspector globally and runs the Kolibri MCP server with the inspector for visual debugging. ```bash # Install MCP Inspector globally npm install -g @modelcontextprotocol/inspector # Run the server with inspector mcp-inspector kolibri-mcp ``` -------------------------------- ### React Integration Example Source: https://github.com/public-ui/kolibri/blob/develop/packages/themes/default/README.md Example of how to register the default theme and define custom elements in a React application. This ensures the UI components are correctly initialized and rendered. ```tsx import { register } from '@public-ui/components'; import { defineCustomElements } from '@public-ui/components/loader'; import { DEFAULT } from '@public-ui/theme-default'; register(DEFAULT, defineCustomElements).then(() => { ReactDOM.createRoot(document.getElementById('root')).render( , ); }); ``` -------------------------------- ### SPA React Component Example Source: https://github.com/public-ui/kolibri/blob/develop/docs/arc42/07-deployment-view.md Shows how to integrate KoliBri components within a React application using framework adapters and lazy loading. Requires installation of relevant packages. ```typescript import { KolButton } from '@public-ui/react'; import { register } from '@public-ui/components'; import { defineCustomElements } from '@public-ui/components/loader'; import { DEFAULT } from '@public-ui/theme-default'; await register(DEFAULT, defineCustomElements); function App() { return ; } ``` -------------------------------- ### Embed KoliBri Hydrate Server in Node.js Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/hydrate-server/README.md Example of creating and starting an instance of the KoliBri Hydrate Server within a Node.js application. It configures REST and gRPC ports and logs the server URLs upon startup. ```ts import { createHydrateServer } from '@public-ui/hydrate-server'; const server = await createHydrateServer({ restPort: 8080, grpcPort: 50052, }); await server.start(); console.log('REST:', server.getRestUrl()); console.log('gRPC:', server.getGrpcEndpoint()); ``` -------------------------------- ### Clone Repository and Navigate Source: https://github.com/public-ui/kolibri/blob/develop/packages/themes/default/README.md Clone your forked repository and navigate to the default theme directory. This is the first step in setting up your local development environment. ```bash git clone https://github.com//kolibri.git cd kolibri/lib/packages/themes/default ``` -------------------------------- ### Static Website HTML Example Source: https://github.com/public-ui/kolibri/blob/develop/docs/arc42/07-deployment-view.md Demonstrates how to include KoliBri components in a static HTML file. Ensure component and theme files are correctly linked. ```html ``` -------------------------------- ### Install pnpm for Development Source: https://github.com/public-ui/kolibri/blob/develop/packages/themes/ecl/README.md Install pnpm globally, which is required for developing the ECL Theme. ```bash npm install -g pnpm ``` -------------------------------- ### Install Dependencies and Build (GitHub Actions) Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/mcp/AGENTS.md Installs project dependencies and runs the build scripts, including pre and post-build steps for sample index generation. This is typically used in CI environments like GitHub Actions. ```bash pnpm install pnpm build # → runs scripts/build-sample-index.mjs pre && unbuild && scripts/build-sample-index.mjs post ``` -------------------------------- ### CDN Only Component Loading Example Source: https://github.com/public-ui/kolibri/blob/develop/docs/arc42/07-deployment-view.md Illustrates loading KoliBri components directly from a CDN without a build step. Useful for quick prototypes or simple integrations. ```html ``` -------------------------------- ### Install Packages with pnpm Source: https://github.com/public-ui/kolibri/blob/develop/README.md Installs all necessary project packages using the pnpm package manager. ```bash pnpm install ``` -------------------------------- ### Initialize KoliBri and Create React Root Source: https://github.com/public-ui/kolibri/blob/develop/packages/adapters/react/README.md Initialize KoliBri with a theme and set up the React root for your application. Ensure to handle potential errors during registration. ```typescript import { defineCustomElements } from '@public-ui/components/loader'; import { register } from '@public-ui/components'; import { DEFAULT } from '@public-ui/theme-default'; register(DEFAULT, defineCustomElements) .then(() => { ReactDOM.createRoot(document.getElementById("root") as HTMLElement).render( ); }) .catch((error) => { /* Handle errors */ }); ``` -------------------------------- ### Install KoliBri Angular Adapter Source: https://github.com/public-ui/kolibri/blob/develop/packages/adapters/angular/v20/README.md Install the KoliBri Angular v20 package using npm or pnpm. ```bash npm install @public-ui/angular-v20 pnpm add @public-ui/angular-v20 ``` -------------------------------- ### Run Basic gRPC Client Test Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/hydrate-server/CONTRIBUTING.md Use this command for a simple one-component test. It starts a server, connects a client, tests rendering, and cleans up automatically. ```bash node test-grpc-client.mjs ``` -------------------------------- ### KoliBri Custom Element Example Source: https://github.com/public-ui/kolibri/blob/develop/docs/arc42/12-glossary.md Shows an example of a KoliBri component implemented as a custom HTML element. ```html ``` -------------------------------- ### Build and Preview Icons Source: https://github.com/public-ui/kolibri/blob/develop/packages/ecl-icons/AGENTS.md Use these commands to build the icon font or preview icons locally. ```bash pnpm --filter @public-ui/icons build ``` ```bash pnpm start ``` -------------------------------- ### Display Kolibri CLI Help Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/kolibri-cli/README.md Use the `--help` flag to display the available commands and options for the Kolibri CLI. ```bash kolibri --help ``` -------------------------------- ### Install cpy-cli for Asset Copying Source: https://github.com/public-ui/kolibri/blob/develop/packages/themes/kern/README.en.md Install cpy-cli as a dev dependency to facilitate copying theme and component assets. ```bash npm install --save-dev cpy-cli ``` -------------------------------- ### Initialize KoliBri and Create Solid Root Source: https://github.com/public-ui/kolibri/blob/develop/packages/adapters/solid/README.md Initialize KoliBri with a theme and create a SolidJS root. This involves registering custom elements and rendering the main application component. ```typescript import { defineCustomElements } from '@public-ui/components/loader'; import { register } from '@public-ui/components'; import { DEFAULT } from '@public-ui/solid'; register(DEFAULT, defineCustomElements) .then(() => { const htmlDivElement: HTMLDivElement | null = document.querySelector('div#app'); if (htmlDivElement instanceof HTMLDivElement) { render(() => , htmlDivElement); } }) .catch(console.warn); ``` -------------------------------- ### Kolibri CLI Migrate Help Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/kolibri-cli/README.md Display the help information for the kolibri migrate command to understand its usage and available options. ```bash kolibri migrate --help ``` -------------------------------- ### Install Project Dependencies Source: https://github.com/public-ui/kolibri/blob/develop/CONTRIBUTING.md Installs all packages within the monorepo. This command should be run after cloning the repository or switching branches. ```shell pnpm i ``` -------------------------------- ### Scalability Scenario (1000+ Components) Source: https://github.com/public-ui/kolibri/blob/develop/packages/components/src/components/_skeleton/PERFORMANCE_ANALYSIS.md Evaluates RAM usage and bug potential when scaling to 1000+ components, suggesting 'WeakMap Pool' for extreme cases but favoring 'new pro WC' as the default. ```markdown Wenn später 1000+ Komponenten im DOM? ────────────────────────────────────── new pro WC: ~600 KB RAM (linear, aber noch okay für Moderns UIs) WeakMap Pool: ~600 KB RAM (identisch, dann würde Optimierung mehr Sinn machen) Singleton: ~2 KB RAM (aber 1000× Potential für Bugs = unmaintainable) Realität: 1000 Komponenten kommen vor (Virtual Scrolling, Data Tables) Lösung: WeakMap Pool beschrieben + kann später hinzugefügt werden Status Quo: new pro WC ist der bessere Default ``` -------------------------------- ### Initialize KoliBri with a Theme Source: https://github.com/public-ui/kolibri/blob/develop/packages/components/src/components/README.md Initialize KoliBri by registering a theme and defining custom elements. This is a required setup step before using components. ```typescript import { defineCustomElements } from '@public-ui/components/loader'; import { register } from '@public-ui/components'; import { DEFAULT } from '@public-ui/theme-default'; register(DEFAULT, defineCustomElements) .then(() => { /* KoliBri ready */ }) .catch((error) => { /* Handle errors */ }); ``` -------------------------------- ### Install KoliBri Standalone via npm/pnpm Source: https://github.com/public-ui/kolibri/blob/develop/packages/adapters/react-standalone/README.md Install the @public-ui/react-standalone package locally using npm or pnpm for use in your project. ```bash npm install @public-ui/react-standalone pnpm add @public-ui/react-standalone ``` -------------------------------- ### Example Contribution Test Command Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/hydrate-server/CONTRIBUTING.md This command demonstrates how to test a specific component, '', using the REST API as part of a contribution. ```bash curl -X POST localhost:3000/hydrate -H "Content-Type: text/html" \ -d 'Test content' ``` -------------------------------- ### HTTP Request Log Examples Source: https://github.com/public-ui/kolibri/blob/develop/packages/tools/mcp/docs/LOGGING.md These examples illustrate the log output for HTTP requests, showing when a request is received and completed. ```text [2025-11-06T09:45:23.400Z] [INFO] HTTP request received { "requestId": 1, "method": "tools/call", "params": { "name": "search", "arguments": { "query": "button" } } } [2025-11-06T09:45:23.500Z] [INFO] HTTP request completed { "requestId": 1, "method": "tools/call" } ```