Opret en Fabric-app med Rayfin CLI

Denne vejledning viser dig, hvordan du bruger Rayfin CLI til at oprette et projekt, køre det lokalt og deployere det til Fabric. Du bruger den samme CLI-arbejdsgang til nye apps og til senere opdateringer af dit skema eller frontend.

I dette selvstudium skal du:

  • Opret et Fabric Apps-projekt ud fra en skabelon.
  • Start appen lokalt.
  • Log ind på Fabric fra CLI.
  • Udrul appen til et Fabric-arbejdsområde.
  • Bekræft udrulningsstatus.

Forudsætninger

  • Adgang til Fabric.
  • Et Fabric-arbejdsområde, hvor du har tilladelser til bidragsyger, medlem eller administrator.
  • Fabric Apps-arbejdsbelastningen er aktiveret i din lejer.
  • Node.js og NPM installeret.

Opret en app med en AI-prompt

Brug følgende prompt med GitHub Copilot eller en anden kodningsagent til at oprette, udforske, køre, tilpasse og udrulle en Fabric-app:

Set up a new Fabric App project called "rayfin-app-ws".

1. Run: npx -y @microsoft/create-rayfin@latest --project-name rayfin-app-ws --template blankapp
2. Open the scaffolded project directory.
3. Explore the project structure and understand the Rayfin app framework.
4. Run: npm run dev
5. Make changes to the app based on my instructions.
6. When ready, deploy with: npx rayfin up

Scaffold-kommandoen leverer projektnavnet og skabelonen til ikke-interaktiv eksekvering. Agenten kan bede om eventuelle resterende arbejdsområder eller udrulningsindstillinger. Gennemgå genererede filer og kommandouddata før udrulning.

Opret en ny app fra CLI

For at støtte en ny app ud fra en skabelon, brug npm create:

npm create @microsoft/rayfin@latest -- my-app --workspace <workspacename>

Standardskabelonen blankapp bliver løst til Universal App. Den opretter et nyt npm-arbejdsområde med backend-konfiguration under rayfin/, frontendkode i packages/frontend/, runtime-datadefinitioner i packages/data/, og delte kontrakter i packages/shared/. Data er deaktiveret, indtil du vælger det.

Gå til projektmappen:

cd my-app

Tip

Hvis du allerede har en tom projektmappe eller eksisterende kildekode, brug npx rayfin init i stedet for npm create.

npx rayfin init .

Gennemgå det genererede projekt

Efter stilladset indeholder projektet de filer, du skal begynde at udvikle:

  • rayfin/rayfin.yml gemmer app-tjenester og udrulningsindstillinger.
  • rayfin/.env gemmer miljøværdier, der bruges af CLI'en.
  • packages/frontend/ indeholder UI og frontend-build.
  • packages/data/ indeholder runtime-entitetsklasser og skema-registrering.
  • packages/shared/ indeholder klientrettede record- og skemakontrakter.

Aktivér vedvarende app-data efter behov:

npm run pack:add -- data-modeling

Denne funktion muliggør Data og tilføjer startdata og delte definitioner. Tjek og services.staticHosting.path indrayfin/rayfin.yml, services.data.path før du tilføjer filer. Andre skabeloner kan bruge en flad rod src/ og rayfin/data/ layout; disse layouts er alternativer, ikke standard Universal App-layoutet.

CLI'en gemmer aktive udrulningsværdier i rayfin/.env og registrerer udrulninger i rayfin/.deployments.json. Offentlige RAYFIN_PUBLIC_* værdier mappes ind i frontends genererede .env.local; brug npx rayfin env --framework vite til at regenerere den uden at deploye.

For en detaljeret fil-for-fil opdeling, se Forstå projektstrukturen.

Kør appen lokalt

Start det lokale udviklingsmiljø:

npx rayfin dev

Denne kommando starter frontend-udviklingsserveren for den stilladsbaserede app og deployerer backend til Fabric. For at bekræfte, at appen starter korrekt, åbn den lokale URL, der vises i terminalen.

Udrul appen til Fabric

Indbyg flere funktioner i din applikation. Efter du har testet dine ændringer, deploy til Fabric igen.

npx rayfin up

For at forhåndsvise udrulningen uden at foretage ændringer, kør:

npx rayfin up --dry-run

Kontrollér installationen

Tjek den nuværende udrulningstilstand:

npx rayfin up status

For et maskinlæsbart svar, brug JSON-output:

npx rayfin up status --json

Efter en vellykket udrulning udskriver CLI'en URL'en til den hostede app og Fabric-portallinket til det deployerede objekt.

Udrul kun database- eller statisk indhold

Hvis du kun har ændret datamodeller, skal du anvende databaseændringerne uden en fuld redeploy:

npx rayfin up db apply

Hvis du kun har ændret frontend-koden, så genudrul de statiske assets:

npx rayfin up staticapp deploy

Tilføj funktioner

Funktioner er TypeScript-funktioner, der kører på serveren inde i din Fabric-app. Brug funktioner til logik, der ikke må køre i browseren, såsom at arbejde med hemmeligheder, tilgå privilegerede data og kalde eksterne tjenester med appens identitet.

npx rayfin functions init

Initializeren bruger services.functions.path , når den er konfigureret, registrerer en arbejdsområdeplacering såsom packages/functions, eller bevarer en eksisterende flad rayfin/functions pakke. Brug --path <relative-path> det til at vælge et sted eksplicit.

Aktiverede funktioner kræver services.functions.auth.type: application. Eksterne kald bruger ctx.Tokens.* appens identitet og dens tilladelser, ikke brugerens eksterne ressource-tilladelser. I de nuværende Fabric-apps er den identitet ejeren af app-genstanden. Giv den adgang til hver ressource. Til sammenligning ctx.getDataClient() bruger den invocationens Rayfin-token og bevarer kalderens datapolitikker.

GitHub Copilot kan generere og opdatere de nødvendige filer og komponenter. Du kan også bede agenten om at køre appen, fejlfinde funktioner lokalt og deploye appen. For eksempel kan du bruge følgende prompt til at bygge en AI-pull request-gennemgangsassistent ved hjælp af funktioner:

Build an app that lets me view all pull requests for the repository
<repoURL>, chat with my Azure AI Foundry agent <agentName> to review
pull requests, and post review comments. Use Functions with application
authentication to connect to Azure AI Foundry and Azure DevOps. Grant the
app identity the required resource permissions, and preserve the caller's
Rayfin data policies when using ctx.getDataClient().

Se Brug funktioner og Forbind funktioner til eksterne ressourcer for identitet og implementeringsdetaljer.

Fejlfinding af almindelige problemer

Login-fejl eller udrulning returnerer 401 eller 403

Kør npx rayfin login igen, og prøv npx rayfin upså igen.

Du skal inspicere, hvad CLI vil gøre

Før du implementerer ændringer, kør npx rayfin up --dry-run.

Appen deployer, men du ændrer kun skemaet

For at skubbe skemaændringer uafhængigt brug npx rayfin up db apply. Hvis du udfører destruktive ændringer som at ændre typen af en kolonne eller fjerne en kolonne, fejler denne kommando. For at tvinge dine ændringer kan du bruge flaget --force . Denne handling kan være en ødelæggende ændring.

Næste trin

  • Sidst opdateret den