CONTRIBUTING.md

Contributing to Quickwit datasource

Development

Prerequisites

You need:

• Docker and compose
• Node.js
• yarn
• golang
• Mage
• A Quickwit instance running locally

Building

All the stack

./build_and_start.sh

Frontend

$ npm install
$ npm run build

When developing the front, use npm run dev.

Backend

$ mage -v

Start Grafana

$ docker compose up grafana

Testing

Frontend

$ npm run test

Backend

$ go test -v ./pkg/...

Storybook

$ npm run storybook

Reset grafana password

docker exec -it grafana-quickwit-datasource bash
grafana-cli admin reset-admin-password <new_password>

Release

TODO