Contributing to Quickwit datasource

July 18, 2025 ยท View on GitHub

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

Release

TODO

Contents

  1. 1Development
  2. 1.1Prerequisites
  3. 1.2Building
  4. 1.3All the stack
  5. 1.4Start Grafana
  6. 1.5Testing
  7. 2Release