Arrel

Català

English
Español
Français

Català

English
Español
Français

Aparença

Support

Instal·lació ​

Requisits ​

  • PHP ^8.5
  • Laravel ^13.0

Instal·lar el paquet ​

Arrel és programari propietari distribuït des d'un repositori privat; cal una llicència vàlida per fer-lo servir en producció (vegeu Pricing).

Com que el repositori és privat, Composer necessita saber d'on el pot descarregar i com autenticar-se. Afegeix-lo a composer.json:

json
{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/arrelphp/arrel"
        }
    ]
}

I instal·la el paquet:

bash
composer require arrel/arrel

Autenticació amb el repositori privat ​

Composer s'autentica amb un token de GitHub amb permís de lectura sobre el repositori. En local, composer config --global github-oauth.github.com <token> el desa a ~/.composer/auth.json.

En un servidor (per exemple, Forge) i en CI, el token també es desa a un auth.json, o s'injecta amb la variable d'entorn COMPOSER_AUTH:

bash
COMPOSER_AUTH='{"github-oauth":{"github.com":"<token>"}}' composer install

Fes servir un token d'abast mínim (només lectura del repositori d'Arrel) i amb data de caducitat, i no el deixis mai dins del repositori de l'aplicació.

El ServiceProvider es registra automàticament via extra.laravel.providers a composer.json (no cal afegir-lo a mà). En arrencar, publica:

  • El fitxer de configuració config/arrel.php, que pots publicar amb php artisan vendor:publish --tag=arrel-config.
  • Les rutes web i API d'Arrel (/{prefix}/{panel}/... i /arrel/api/{panel}/...).
  • Les traduccions del paquet, sota el namespace arrel::.
  • Un singleton de PanelRegistry, on registraràs els teus Panels.

Publicar els assets compilats ​

El frontend d'Arrel (Vue, precompilat) es distribueix dins del paquet i s'ha de publicar al directori public/ de la teva aplicació:

bash
php artisan arrel:assets

Això copia dist/ a public/vendor/arrel i hi escriu un fitxer .hash. Cada resposta HTML del panell (resources/views/panel.blade.php) inclou aquest hash com a query string (arrel.css?v=..., arrel.js?v=...), i AssetsManifest::ensureFresh() falla sorollosament en mode debug si detecta que els assets publicats no coincideixen amb els del paquet instal·lat, per evitar servir JS obsolet sense adonar-te'n després d'un composer update.

Torna a executar php artisan arrel:assets cada vegada que actualitzis la versió d'arrel/arrel.

Verificar la instal·lació ​

Un cop publicats els assets i registrat un Panel, obre /arrel/{id-del-panell} al navegador. Hauries de veure la pantalla d'inici de sessió. Si no la veus, comprova que sanctum.stateful conté el domini on estàs treballant.

Neteja d'uploads temporals ​

Els camps File/Image pugen primer a un directori temporal (arrel-temp, disc local) abans de moure's a la seva ubicació final quan es desa el formulari (vegeu Camps). Programa aquesta comanda perquè netegi els que es queden orfes:

bash
php artisan arrel:prune-uploads

Esborra qualsevol fitxer de arrel-temp amb més de 24 hores. Un bon lloc per programar-la és el routes/console.php de la teva aplicació, amb l'scheduler de Laravel:

php
Schedule::command('arrel:prune-uploads')->daily();

Següent pas ​

Amb el paquet instal·lat, el següent pas és configurar un Panel: decidir quins Resources, pàgines i widgets hi viuen, i incrustar-lo en una ruta de la teva aplicació.