Към съдържанието

Хостване на регистър

Регистърът представлява файл 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.