Skip to content

Commit 56bc9d8

Browse files
authored
Merge branch 'main' into ivana/fix-percent-unit
2 parents 55dac6a + 527339c commit 56bc9d8

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

README.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,42 +10,46 @@ Visualize your Google Spreadsheets with Grafana
1010

1111
Check the [docs](https://github.com/grafana/google-sheets-datasource/blob/main/src/README.md) for information on how to use the data source.
1212

13-
## Development
13+
## Development guide
14+
15+
This is a basic guide on how to set up your local environment, make the desired changes and see the result with a fresh Grafana installation.
16+
17+
## Requirements
1418

1519
You need to install the following first:
1620

1721
- [Mage](https://magefile.org/)
1822
- [Yarn](https://yarnpkg.com/)
1923
- [Docker Compose](https://docs.docker.com/compose/)
2024

21-
### Building the Plug-In
25+
## Running the development version
2226

23-
In order to build the plug-in, both front-end and back-end parts, do the following:
27+
### Compiling the Backend
2428

25-
```
26-
yarn install
27-
yarn build
28-
```
29+
If you have made any changes to any `go` files, you can use [mage](https://github.com/magefile/mage) to recompile the plugin.
2930

30-
The built plug-in will be in the dist/ directory.
31+
```sh
32+
mage buildAll
33+
```
3134

32-
### Testing the Plug-In w/ Docker Compose
35+
### Compiling the Frontend
3336

34-
To test the plug-in running inside Grafana, we recommend using our Docker Compose setup:
37+
After you made the desired changes, you can build and test the new version of the plugin using `yarn`:
3538

36-
```BASH
37-
mage buildAll
39+
```sh
40+
yarn run dev # builds and puts the output at ./dist
3841
```
3942

40-
In another terminal
43+
The built plug-in will be in the `dist/` directory.
44+
45+
### Docker Compose
4146

42-
```BASH
47+
To test the plug-in running inside Grafana, we recommend using our Docker Compose setup:
48+
49+
```sh
4350
docker-compose up
4451
```
4552

46-
To restart the plug-in after backend changes:
47-
`./scripts/restart-plugin.sh`
48-
4953
### Test spreadsheet
5054

5155
Need at publicly available spreadsheet to play around with? Feel free to use [this](https://docs.google.com/spreadsheets/d/1TZlZX67Y0s4CvRro_3pCYqRCKuXer81oFp_xcsjPpe8/edit?usp=sharing) demo spreadsheet that is suitable for visualization in graphs and in tables.

0 commit comments

Comments
 (0)