Arbeiten in der Cloud

Mit der Code Hub-Benutzeroberfläche können Sie eine VCR-Anwendung direkt von Ihrem Browser aus bereitstellen, ohne lokale Tools zu verwenden. Wenn Sie lieber Ihre eigenen Tools verwenden möchten, lesen Sie unsere Anleitung zu Arbeit vor Ort.

Besuchen Sie die Vonage Code-Hub Landing Page, um loszulegen. Sie können zunächst durch die Liste der verfügbaren Muster für unsere Produkte blättern oder die Suchfunktion nutzen, um das zu finden, was Sie gerne bauen möchten.

Vonage Code Hub landing page

Sobald Sie auf das gewünschte Muster klicken, wählen Sie Code bereitstellen.

"Schedule an SMS" product page

Code bereitstellen

Code bereitstellen ermöglicht Ihnen die sofortige Bereitstellung eines Instanz einer Anwendung, damit Sie sie in Aktion sehen können. Wenn Sie eine Instanz eines Projekts erstellen, können Sie mehrere Parameter konfigurieren, darunter die Region, in der die Bereitstellung gehostet wird, den Instanznamen und andere für das Projekt relevante Parameter (z. B. eine Vonage-Nummer zum Senden von SMS-Nachrichten):

The form to create an instance

Wenn Sie noch keine Vonage-Nummer haben, können Sie eine erwerben, indem Sie "Nummer zuweisen" wählen. Sobald die Instanz erstellt ist, erscheint sie in der Liste unter "Code bereitstellen", wo Sie auch weitere Instanzen erstellen können, die in anderen Regionen laufen. Bitte beachten Sie, dass Sie für jede Instanz eine andere Nummer benötigen, wenn das Projekt eine Vonage-Nummer erfordert.

A list of instances created for the "Schedule an SMS" project.

Sobald die Instanz erstellt wurde, können Sie sie anklicken, um die Anwendung zu starten und zu verwenden.

Veröffentlichung auf Code Hub

Wenn Sie ein Entwickler sind und Ihre eigene VCR-Anwendung im Code Hub veröffentlichen möchten, damit andere sie mit einem einzigen Klick einsetzen können, müssen Sie eine setup.json Datei in Ihrem Projekt neben vcr.yml. Diese Datei definiert das Konfigurationsformular, das die Benutzer ausfüllen, wenn sie Ihr Produkt bereitstellen.

Speicherort der Datei

your-project/
├── vcr.yml
├── setup.json
└── ...

Grundlegende Struktur

{
  "data": [
    {
      "type": "TEXT",
      "title": "Company Name",
      "description": "The name of your company.",
      "name": "COMPANY_NAME"
    }
  ]
}

Jeder Eintrag in data entspricht einer Umgebungsvariablen, die in vcr.yml. Die name muss genau mit dem Namen der Umgebungsvariablen übereinstimmen.

Feldtypen

Typ Beschreibung
TEXT Freitext-Eingabe
SECRET Texteingabe, Wert ist verborgen (für sensible Daten)
PHONE_NUMBER Ermöglicht dem Benutzer den Kauf und die Verknüpfung einer Vonage-Nummer. verwenden features zu spezifizieren ["VOICE"], ["SMS"]oder beides.
EXTERNAL_ACCOUNT Verknüpfen Sie einen externen Messaging Account (WhatsApp, Messenger, etc.). verwenden providers um die unterstützten Anbieter anzugeben.
SELECT Dropdown-Liste. verwenden options Array (name/value Paare). Wird als JSON-String übermittelt. hinzufügen "multi": true für Mehrfachauswahl.
TOGGLE Kontrollkästchen. Eingereicht als "true" oder "false".
CONFIGURATION_SELECTOR Bedingte Einrichtung - zeigt je nach Auswahl des Benutzers verschiedene Unterformulare an.

Gemeinsame Eigenschaften

Eigentum Erforderlich Beschreibung
type Ja Einer der oben genannten Typen
name Ja Name der Umgebungsvariablen (muss mit vcr.yml)
title Ja Dem Benutzer angezeigtes Etikett
description Ja Hilfetext. Unterstützt Markdown-Links: [label](url)
optional Nein Satz true um das Feld optional zu machen. Alle Felder sind standardmäßig erforderlich.
defaultValue Nein Standardwert. Unterstützt bei TEXT, SELECTund TOGGLE nur.

Beispiele für Typen

PHONE_NUMBER:

{
  "type": "PHONE_NUMBER",
  "title": "Vonage Number",
  "description": "A Vonage number for your application.",
  "features": ["VOICE", "SMS"],
  "name": "VONAGE_NUMBER"
}

SELECT:

{
  "type": "SELECT",
  "title": "Environment",
  "description": "Which environment are you deploying to?",
  "name": "CODE_ENV_REQ",
  "options": [
    { "name": "Production", "value": "PROD" },
    { "name": "Quality Assurance", "value": "QA" },
    { "name": "Development", "value": "DEV" }
  ],
  "defaultValue": "PROD"
}

CONFIGURATION_SELECTOR:

Verwenden Sie diese Option, wenn Ihr Produkt mehrere sich gegenseitig ausschließende Konfigurationsabläufe unterstützt.

{
  "type": "CONFIGURATION_SELECTOR",
  "name": "__configuration_type__",
  "title": "Configuration Type",
  "description": "Select configuration type",
  "options": [
    { "name": "Basic", "value": "basic" },
    { "name": "Advanced", "value": "advanced" }
  ],
  "configurations": [
    {
      "basic": [
        { "type": "TEXT", "name": "API_URL", "title": "API URL", "description": "Your API endpoint." }
      ]
    },
    {
      "advanced": [
        { "type": "TEXT", "name": "API_URL", "title": "API URL", "description": "Your API endpoint." },
        { "type": "SECRET", "name": "API_KEY", "title": "API Key", "description": "Your API key." }
      ]
    }
  ]
}

Tasten in configurations muss genau mit dem value einer Option. Der Wert der ausgewählten Option wird als Umgebungsvariable mit dem Befehl name Feld.

Um Ihre Anwendung im Code Hub zu veröffentlichen, verwenden Sie die neru-mcp MCP-Server.