QuestDB UI

This repository hosts the implementation of QuestDB user interface and surrounding tooling.

Prerequisites

• Node.js >= 18.18.0 (check with node -v)
• Yarn 4.1.1+ (check with yarn -v)

If your Node.js version doesn't match, use fnm or nvm to switch versions:

fnm use  # or nvm use

If Yarn is not installed, enable it with:

corepack enable

Quick Start

1. Clone the repository:

   git clone git@github.com:questdb/ui.git
   cd ui

2. Install dependencies:

   yarn

3. Start the development server:

   yarn start

4. Open http://localhost:9999 in your browser. Note that for Web Console to work properly, QuestDB server should be up and running.

Available Scripts

• yarn start - Start development server (Vite)
• yarn build - Build for production
• yarn preview - Preview production build locally
• yarn test:unit - Run unit tests (Vitest)
• yarn test:e2e - Run end-to-end tests (Cypress)
• yarn test:e2e:auth - Run auth-specific e2e tests
• yarn test:e2e:enterprise - Run enterprise e2e tests
• yarn typecheck - Run TypeScript type checking
• yarn lint - Lint source code (ESLint)
• yarn lint:fix - Fix linting issues automatically
• yarn sync:questdb - Move the e2e/questdb submodule to the head of QuestDB master and stage it

Development Notes

Running E2E Tests

E2E tests require a running QuestDB server. The tests connect to localhost:9000 by default.

QuestDB Submodule

CI builds the QuestDB server for E2E tests from the e2e/questdb submodule. The "Check OSS Submodule" workflow fails a push when the submodule is not one of the latest commits of QuestDB master. To fix it, run:

yarn sync:questdb

Then commit the staged e2e/questdb change. The first run clones the submodule if it is not initialized yet.

To test against a QuestDB branch that is not merged yet, check out that commit in e2e/questdb and commit the pointer as usual. Run yarn sync:questdb before merging.

Working with Context Path

To test with a custom context path:

QDB_HTTP_CONTEXT_WEB_CONSOLE=/context yarn preview

Contributing

We always welcome contributions from the community!

If you need help, here are some useful links:

• Check GitHub issues for existing discussions
• Read the QuestDB Documentation
• Join our Slack Channel or Community Forum