Ga naar de inhoud

Een register hosten

Een register bestaat uit een registry.json-bestand en een verzameling blokmappen die via HTTP worden aangeboden. Er is geen speciale server nodig. Alles wat statische bestanden kan aanbieden, werkt.

Wat u nodig hebt

  1. Een registry.json-bestand met een lijst van uw blokken
  2. Blokmappen met de bestanden waarnaar in het manifest wordt verwezen
  3. Een webserver of hostingdienst die beide aanbiedt

Mapstructuur

Een typische registerrepository ziet er zo uit:

Code
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

De registry.json verwijst naar de map blocks/ als zijn baseUrl:

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

Vereisten

De hosting moet directe bestandstoegang via URL ondersteunen. De CLI haalt bestanden op door URL’s samen te stellen op basis van {baseUrl}/{block.name}/{file}.

De CLI heeft geen eigen aanmeldingsproces. Regel toegangsbeheer voor privérepositories op de hostinglaag (e.g bijvoorbeeld privérepositories op GitHub met tokens, of een server die inloggegevens controleert) en laat gebruikers de inloggegevens als aangepaste headers versturen via de objectindeling in blocks.jsonformaat.

Uw register testen

Test het lokaal voordat u publiceert door een eenvoudige HTTP-server te starten:

Shell
cd my-registry
npx serve .

Stel vervolgens uw blocks.json in op http://localhost:3000/registry.json en voer npx blockstudio list uit om te controleren of alles wordt gevonden. list haalt alleen registry.json op. Stel tijdens het testen baseUrl in op http://localhost:3000/blocks om add te testen, omdat de CLI blokbestanden downloadt van baseUrl.