@questdb/web-console

QuestDB Web Console

This package contains code of the GUI for interacting with QuestDB.

It is a web application built with TypeScript and React and managed with Yarn@3 and Webpack.

Local development setup

TL;DR;

git clone [e-mail]/questdb/ui.git
cd ui
docker run -p 9000:9000 -p 9009:9009 -p 8812:8812 questdb/questdb
yarn
yarn workspace @questdb/web-console start

Prerequisites

• use node v16.13.1
  version is specified in .nvmrc file. You can use nvm or fnm to manage node versions on your machine.
• monorepo is managed with yarn@3.
  Follow official installation guide. It should be enough to run corepack enable to have yarn enabled.
• This package is a frontend client for QuestDB. Therefore, it requires a locally running QuestDB instance. Check readme.md of QuestDB to learn how to install it.
  If you have docker, then it's simply:

  docker run -p 9000:9000 -p 9009:9009 -p 8812:8812 questdb/questdb
  

Start development environment

1. Setup dependencies with yarn:

yarn

1. Start development environment

yarn workspace @questdb/web-console start

1. Open localhost:9999

make sure you have a local QuestDB instance running, as mentioned in "Prerequisites" above.

1. Happy hacking!

Run build

1. Make sure dependencies are set up:

yarn

1. Run build script:

yarn workspace @questdb/web-console run build

1. Build process emits static HTML, CSS and JS files in packages/web-console/dist

Run tests

This monorepo contains browser-tests package which is used to test web-console package. browser-tests does not yet run as part of web-console build on CI, but they can be used to test changes locally.

Tests are written with Cypress E2E framework.

1. start web-console local dev environment as explained above in this document.
2. run tests with

yarn workspace browser-tests test

or

yarn workspace browser-tests run cypress open