@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

In order to run this package locally, you need to do the following steps:

1. Clone and bootstrap repository (by following instructions on local-development-setup.md)
2. Start development server
3. Run QuestDB in the background
4. Hack!

1. Clone and bootstrap repository

Consult instructions on local-development-setup.md document.

2. Build the production version of @questdb/react-components, which this repository uses:

yarn workspace @questdb/react-components build

3. Start development server

yarn workspace @questdb/web-console start

localhost:9999 should show web console

4. Run QuestDB in the background

This package (web-console) is a only GUI for QuestDB, it does not include QuestDB itself.
GUI will work without it, but because it's a tool to interact with QuestDB, you will need QuestDB as well.

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

5. Hack!

Do your code changes and browser will automatically refresh localhost:9999.

Happy hacking!

Build production version

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

Bundle size watcher

Web Console uses BundleWatcher to make sure there is no unintentional blowup of assets size. The current limits, defined in the package.json, are as following:

File	Max allowed size
dist/vendor.*.js	3MB
dist/qdb.*.js	500KB
dist/qdb.*.css	100KB
dist/vendor.*.css	100KB

If you need to introduce a heavy library or anything that by design is expected to go over the defined limits, make sure to change the watcher configuration.

Run tests

Unit tests

This package uses Jest for unit tests.

To run them locally while developing, run:

yarn workspace @questdb/web-console run test

This will start jest in watch mode and will rerun tests on file changes.

If you want to run tests once, use:

yarn workspace @questdb/web-console run test:prod

This command is also used in CI.

Browser 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