Liigu sisu juurde

Registri majutamine

Register koosneb registry.json failist ja plokkide kaustadest, mida pakutakse HTTP kaudu. Eraldi serverit pole vaja. Sobib iga lahendus, mis suudab staatilisi faile pakkuda.

Vajalikud osad

  1. registry.json fail, kus on loetletud teie plokid
  2. Plokkide kaustad failidega, millele manifestis viidatakse
  3. Veebiserver või majutusteenus, mis pakub mõlemat

Kataloogistruktuur

Tüüpiline registrihoidla näeb välja selline:

Kood
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 osutab kataloogile blocks/ kui oma baseUrl-ile:

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

Nõuded

Majutuskeskkond peab võimaldama failidele otse juurde pääseda URL kaudu. CLI hangib failid, luues URL-id {baseUrl}/{block.name}/{file} põhjal.

CLI-il pole oma sisselogimisvoogu. Privaatsete registrite puhul korraldage juurdepääsukontroll majutuskihis (e.g näiteks privaatsetes GitHub hoidlates tõenditega või serveris, mis kontrollib mandaate) ning laske tarbijatel saata mandaadid kohandatud päistena objektivormingu kaudu jaotises blocks.json.

Registri testimine

Enne avaldamist testige registrit kohapeal, käivitades lihtsa HTTP serveri:

Shell
cd my-registry
npx serve .

Seejärel määrake oma blocks.json aadressiks http://localhost:3000/registry.json ja käivitage npx blockstudio list, et kontrollida, kas kõik lahendatakse. list hangib ainult registry.json. add testimiseks määrake testimise ajaks baseUrl väärtuseks http://localhost:3000/blocks, sest CLI laadib plokifailid asukohast baseUrl.