This tutorial is meant to guide you from being entirely new to the grafana-app-sdk to being able to write your own bespoke applications to run on grafana as a platform. To do so, we'll walk through creating a simple issue tracker app for grafana, and run it locally (or on a kubernetes cluster of your choosing). Along the way, we'll cover all the SDK's CLI tooling, and a lot of the SDK's library packages. In the end, we'll have an app which allows users to create, list, update, and delete "issues," as well as responds to changes in issue status by taking some arbitrary action.
For this tutorial, we make the following assumptions:
- You have at least a basic understanding of Go. This is the language back-end code for grafana apps is written in.
- You have at least a basic understanding of TypeScript. This is the language front-end code for grafana is written in. Some parts of this tutorial will have us writing in CUE, but no familiarity with the language is assumed--we'll break down everything we're writing there.
You'll also need Go installed on your machine to compile the code, as well as the following tools for plugin development:
For running the local environment, you'll need:
We'll also bring these up again when they become relevant in our process.
OK, with all that out of the way, let's jump in with Initializing Our Project, or you can select a section from the chapter list below.