Перейти до вмісту

Розміщення реєстру

Реєстр складається з файлу registry.json і набору тек із блоками, які надаються через HTTP. Спеціальний сервер не потрібен. Підійде будь-який сервіс, що розміщує статичні файли.

Що потрібно

  1. Файл registry.json зі списком ваших блоків
  2. Теки блоків із файлами, на які є посилання в маніфесті
  3. Вебсервер або хостинг, що надає доступ до обох типів файлів

Структура каталогів

Типовий репозиторій реєстру має такий вигляд:

Код
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 вказує на каталог blocks/ як на свій baseUrl:

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

Вимоги

Хостинг має підтримувати прямий доступ до файлів через URL. CLI отримує файли, формуючи URL-адреси на основі {baseUrl}/{block.name}/{file}.

У CLI немає власного процесу входу. Для приватних реєстрів налаштуйте контроль доступу на рівні хостингу (e.g. приватні GitHub репозиторії з токенами або сервер, що перевіряє облікові дані) і налаштуйте клієнтів передавати облікові дані як власні заголовки через формат об’єкта в blocks.json.

Тестування реєстру

Перед публікацією перевірте реєстр локально, запустивши простий сервер HTTP:

Командна оболонка
cd my-registry
npx serve .

Потім укажіть blocks.json адресу http://localhost:3000/registry.json і запустіть npx blockstudio list, щоб перевірити, чи все знаходиться. list отримує лише registry.json. Щоб перевірити add, під час тестування встановіть baseUrl у значення http://localhost:3000/blocks, адже CLI завантажує файли блоків із baseUrl.