Přejít k obsahu

Hostování registru

Registr tvoří soubor registry.json a sada složek s bloky, které se poskytují přes HTTP. Není potřeba žádný speciální server. Postačí cokoli, co dokáže poskytovat statické soubory.

Co potřebujete

  1. Soubor registry.json se seznamem bloků
  2. Složky bloků se soubory uvedenými v manifestu
  3. Webový server nebo hostingovou službu, která poskytuje obojí

Struktura adresářů

Typický repozitář registru vypadá takto:

Kód
my-registry/
  registry.json
  blocks/
    hero/
      block.json
      index.php
      style.scss
    tabs/
      block.json
      index.php
      style.scss
    tab-item/
      block.json
      index.php

registry.json odkazuje na adresář blocks/ jako na svůj baseUrl:

JSON
{
  "name": "my-registry",
  "baseUrl": "https://example.com/blocks",
  "blocks": [
    {
      "name": "hero",
      "title": "Hero",
      "files": ["block.json", "index.php", "style.scss"]
    }
  ]
}

Požadavky

Hosting musí podporovat přímý přístup k souborům přes URL. CLI načítá soubory sestavením adres URL z {baseUrl}/{block.name}/{file}.

CLI nemá vlastní přihlašovací proces. U soukromých registrů zajistěte řízení přístupu na úrovni hostingu (e.g například soukromé repozitáře GitHub s tokeny nebo server, který ověřuje přihlašovací údaje) a nechte uživatele posílat přihlašovací údaje jako vlastní hlavičky prostřednictvím formátu objektu v blocks.json.

Testování registru

Před zveřejněním otestujte registr místně spuštěním jednoduchého serveru HTTP:

Shell
cd my-registry
npx serve .

Poté nastavte blocks.json na http://localhost:3000/registry.json a spusťte npx blockstudio list, abyste ověřili, že se vše správně načítá. list načítá pouze registry.json. Chcete-li otestovat add, nastavte během testování baseUrl na http://localhost:3000/blocks, protože CLI stahuje soubory bloků z baseUrl.