https://github.com/scottlepp/github-projects
https://github.com/scottlepp/github-projects
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/scottlepp/github-projects
- Owner: scottlepp
- License: other
- Created: 2020-03-30T15:56:31.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T23:37:57.000Z (over 2 years ago)
- Last Synced: 2025-02-11T12:44:41.362Z (5 months ago)
- Language: TypeScript
- Size: 3.84 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Projects Grafana Datasource
## Features
Observe GitHib Projects
## How to install the plugin:
1. Install Grafana
2. Clone this repo to the grafana plugins folder (`git clone https://github.com/grafana/github-projects /var/lib/grafana/plugins/github-projects`)
## Using the plugin
From the dashboard, add a panel and select GitHub Projects from the Query dropdown. You will see a SQL Editor.
Enter your SQL and click away to run the SQL command and get results into the panel.
## How to contribute
This plugin is using Typescript.
All the code goes into the `src` folder, and we let `webpack` watch for changes and update the `dist` folder.
Grafana only reads the `dist` folder, and must be included with any release.
## Developing without docker
1. Install Grafana
2. `git clone https://github.com/scottlepp/github-projects`
3. `cd github-projects`
4. `yarn install --pure-lockfile`
5. `yarn watch` or `yarn dev`
## Developing with docker
1. `git clone https://github.com/grafana/github-projects`
2. `cd github-projects`
3. `` docker run -d -p 3000:3000 --name grafana -v `pwd`:/var/lib/grafana/plugins/github-projects/ grafana/grafana ``
4. `yarn install --pure-lockfile`
5. `yarn watch`
## Using docker-compose
```
version: "3"
services:
grafana:
image: grafana/grafana:${GRAFANA_VERSION:-latest}
ports:
- "3000:3000"
volumes:
- ./dist:/var/lib/grafana/plugins/github-projects
- ${GRAFANA_PROVISIONING:-./provisioning}:/etc/grafana/provisioning
- ${HOME}:${HOME}
environment:
- TERM=linux
```
Note the following environment variables that can be used:
1. `GRAFANA_VERSION`: The grafana version you wish to use (default: latest)
2. `GRAFANA_PROVISIONING`: The directory pointing to provisioning files (default: `./provisioning`)
3. Your home directory will be mapped to home in the container