ichava/icon-browser

Three badges, not four: the package is proprietary, not MIT.

The HTTP layer for the Ichava Laravel icon ecosystem: the icon browser (React and Inertia pages, built from resources/js), the REST API and the middleware, installed on top of ichava/core.

A licensed, proprietary package: the repository is public, the code is not open source. Targets PHP ^8.4.1 || ^8.5 on Laravel ^13, against ichava/core ^0.1. Core and the icon packs stay open source and work headless without it.

Install

The package is listed on Packagist. Core's laranail/* dependencies are not yet, so Composer needs their repository entries first:

for p in package-tools console enumerator db-tools; do
  composer config "repositories.laranail-$p" vcs "https://github.com/laranail/$p"
done
composer require ichava/icon-browser:^0.1

Installation gives the repository entries, the optional COMPOSER_AUTH token for CI, and the asset publishing.

Quick start guide and usage

Getting started

Publish the config and the pre-built browser bundle, and seed at least one icon pack:

php artisan vendor:publish --tag=ichava::icon-browser-config
php artisan vendor:publish --tag=ichava::icon-browser-assets
composer require ichava/icon-sets-tabler
php artisan ichava::ichava-core.database seed --package=ichava/icon-sets-tabler

Usage

Open the browser at /{prefix}/icons (/ichava/icons by default, or wherever ICHAVA_BROWSER_PATH puts it). To expose the JSON API as well, turn it on:

ICHAVA_API_ENABLED=true

curl "https://example.test/ichava/api/v1/icons?search=home&packages[]=ichava/icon-sets-tabler"

Getting started walks through both; the Documentation index covers the rest.

Documentation

The docs live in this repository, under docs/.

Guides

• Installation — repository entries, the licence, config, asset publishing, the prefix
• Getting started — the browser and your first REST call
• Configuration — every config key and what it changes
• Environment variables — the ICHAVA_BROWSER_* surface
• Architecture — what the package ships, the browser UI and its Untitled UI PRO components, the middleware stack, hybrid auth
• Release — how a version is cut, and how the browser UI is updated

Reference

• API endpoints — every route, its parameters and its shape
• Host integration — the host's user, Gates, the owner-keyed library, the features manifest, the install command
• Payload schema — the JSON Schema every payload matches

Recipes

• Add to a Breeze app — the browser behind the host's login
• Use with a Sanctum SPA — the REST API for an SPA
• REST mode in a non-Inertia app — the API without the Inertia pages
• Grant admin access — one Gate for status and the cache
• Turn features off — hide what the host does not offer
• Work on the browser UI — dev server with hot reload, checks, e2e and the one build

Ecosystem

• Core architecture
• Troubleshooting

Contributing & security

Contributions come from licensed collaborators with access to this repository; see CONTRIBUTING.md. Report vulnerabilities to security@simtabi.com, never in an issue; see SECURITY.md.

License

Proprietary. © Simtabi LLC, all rights reserved. The browser interface includes Untitled UI PRO components, used under the Untitled UI licence. See LICENSE.