@questdb/web-console 1.1.4 → 1.1.5

package/README.md

@@ -1,144 +1,74 @@
-# QuestDB Web Console
+# QuestDB UI
 
-This package contains code of the GUI for interacting with QuestDB.
+This repository hosts the implementation of QuestDB user interface and surrounding tooling.
 
-It is a web application built with TypeScript and React and managed with
-Yarn@3 and Webpack.
+## Prerequisites
 
-## Local development setup
+- **Node.js** >= 18.18.0 (check with `node -v`)
+- **Yarn** 4.1.1+ (check with `yarn -v`)
 
-In order to run this package locally, follow the steps below.
-
-### 1. Clone and bootstrap repository
-
-Follow the instructions described
-in [`local-development-setup.md`](../../docs/local-development-setup.md) document.\
-After the local development environment setup, you are ready to work on the packages of this project,
-including the web console.
-
-### 2. Build the production version of `@questdb/react-components`
-
-The web console uses the `@questdb/react-components` package, so build this dependency first.
-```
-yarn workspace @questdb/react-components build
+If your Node.js version doesn't match, use [fnm](https://fnm.vercel.app) or [nvm](https://github.com/nvm-sh/nvm) to switch versions:
+```bash
+fnm use  # or nvm use
 ```
 
-### 3. Start development server
-
-Now we can start the web console.
-```
-yarn workspace @questdb/web-console start
+If Yarn is not installed, enable it with:
+```bash
+corepack enable
 ```
 
-By default, [localhost:9999](http://localhost:9999) should display the web console.
+## Quick Start
 
-If the server has a context path configured with the `http.context.path` option, we need to make sure that
-the dev server is aware of it, and it proxies requests accordingly.\
-We can set the context path with the following environment variable before starting dev server:
-```
-QDB_HTTP_CONTEXT_WEB_CONSOLE=/instance2
-export QDB_HTTP_CONTEXT_WEB_CONSOLE
-yarn workspace @questdb/web-console start
-```
+1. Clone the repository:
+   ```bash
+   git clone git@github.com:questdb/ui.git
+   cd ui
+   ```
 
-After the above the web console is available on [localhost:9999/instance2/](http://localhost:9999/instance2/)
+2. Install dependencies:
+   ```bash
+   yarn
+   ```
 
-If the context path is removed from the server configuration, we also need to clear the environment variable,
-and restart the dev server:
-```
-unset QDB_HTTP_CONTEXT_WEB_CONSOLE
-yarn workspace @questdb/web-console start
-```
+3. Start the development server:
+   ```bash
+   yarn start
+   ```
 
-### 4. Run QuestDB in the background
+4. Open [http://localhost:9999](http://localhost:9999) in your browser. Note that for Web Console to work properly, [QuestDB server](https://github.com/questdb/questdb) should be up and running.
 
-This package (`web-console`) is a GUI for QuestDB, it does not include QuestDB itself.\
-The web console will load from the dev server without the database, but because it is a tool
-to interact with QuestDB, you need to run the database as well to be able to work with it
-properly.
+## Available Scripts
 
-Check [README.md](https://github.com/questdb/questdb#install-questdb) of QuestDB to learn how to install it.
+- `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
 
-If you have [`docker`](https://docs.docker.com/get-docker/), then it is simply:
+## Development Notes
 
-```
-docker run -p 9000:9000 -p 9009:9009 -p 8812:8812 questdb/questdb
-```
-
-### 5. Hack!
-
-You can start changing the code, and the web console will automatically refresh
-on [localhost:9999](http://localhost:9999).
-
-Happy hacking!
+### Running E2E Tests
 
-## Build production version
+E2E tests require a running QuestDB server. The tests connect to `localhost:9000` by default.
 
-1. Make sure dependencies are set up:
+### Working with Context Path
 
+To test with a custom context path:
+```bash
+QDB_HTTP_CONTEXT_WEB_CONSOLE=/context yarn preview
 ```
-yarn
-```
-
-2. Run `build` script:
-
-```
-yarn workspace @questdb/web-console run build
-```
-
-3. Build process emits static HTML, CSS and JS files in `packages/web-console/dist`
-
-## Bundle size watcher
-Web Console uses [BundleWatcher](https://github.com/bundlewatch/bundlewatch) 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](https://jestjs.io/) 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](https://www.cypress.io/) E2E framework.
+## Contributing
 
-1. start `web-console` local dev environment as explained above in this document.
-2. run tests with
-  ```
-  yarn workspace browser-tests test
-  ```
+We always welcome contributions from the community!
 
-  or
+If you need help, here are some useful links:
 
-  ```
-  yarn workspace browser-tests run cypress open
-  ```
+- Check [GitHub issues](https://github.com/questdb/ui/issues) for existing discussions
+- Read the [QuestDB Documentation](https://questdb.com/docs/)
+- Join our [Slack Channel](https://slack.questdb.io/) or [Community Forum](https://community.questdb.io/)