app-sdk-concepts

What problem does it solve?

It removes the guesswork and repetitive setup required to build, scaffold, and deploy Grafana App Platform applications by documenting the grafana-app-sdk workflow, project layout, deployment modes, and local development steps. Authors gain a clear, repeatable process for initializing projects, generating Go/TypeScript types and CRDs, wiring apps into Grafana, and choosing the correct runtime mode.

Core Features & Use Cases

• Project initialization & scaffolding: guidance for project init, adding operator or frontend components, and cleaning up grafana/apps-style scaffolds.
• Code generation & artifacts: describes generate flows to produce Go types, TypeScript types, AppManifest, and CRDs and where to find them.
• Deployment modes & local dev: explains standalone operator, grafana/apps submodule, and frontend-only modes plus local k3d/Tilt workflows for testing.
• Use case: bootstrap a new Grafana app that defines CUE kinds, generate types, implement reconcilers and admission handlers, and run locally with k3d for development and testing.

Quick Start

Run the grafana-app-sdk CLI to initialize a new module, add operator or frontend components as needed, run generate to produce types and manifests, and use the generated Makefile to build and run locally.