https://github.com/scriptsmith/up-datasource

Up Bank API Grafana Datasource Plugin
https://github.com/scriptsmith/up-datasource

grafana openapi openapi-generator up-banking

Last synced: 1 day ago
JSON representation

Up Bank API Grafana Datasource Plugin

• Host: GitHub
• URL: https://github.com/scriptsmith/up-datasource
• Owner: ScriptSmith
• License: apache-2.0
• Created: 2022-10-24T13:29:55.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-24T13:59:05.000Z (about 2 years ago)
• Last Synced: 2024-10-11T20:15:44.689Z (26 days ago)
• Topics: grafana, openapi, openapi-generator, up-banking
• Language: TypeScript
• Homepage:
• Size: 577 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        






# Up Bank Grafana Datasource Plugin

Using the Up API

- Docs: https://developer.up.com.au/

- Repo: https://github.com/up-banking/api

![](src/screenshots/dashboard.png)

# Try it locally

Generate API from OpenAPI spec

```

yarn build:api

```

Build plugin in dev mode

```

yarn dev

```

Start grafana

```

docker-compose up

```

Navigate to http://localhost:3000 and login with username `admin` and password `admin`

Go to `Settings` -> `Data sources` -> `Add data source`

Scroll to the bottom and select `Up Bank`

Follow the instructions to generate your Personal Access Token for the Up API: https://developer.up.com.au/#getting-started

Click `Save & test`

Click the `Dashboards` tab, and import the sample dashboard

Then go home, and select the new dashboard

More details on local plugins: https://grafana.com/docs/grafana/latest/developers/plugins/development-with-local-grafana/