@questdb/web-console 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -13
- package/dist/qdb.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,25 +1,68 @@
|
|
|
1
|
-
# QuestDB Console
|
|
1
|
+
# QuestDB Web Console
|
|
2
|
+
|
|
3
|
+
This package contains code of the GUI for interacting with QuestDB.
|
|
4
|
+
|
|
5
|
+
It is a web application built with TypeScript and React and managed with
|
|
6
|
+
Yarn@3 and Webpack.
|
|
7
|
+
|
|
8
|
+
## Local development setup
|
|
9
|
+
|
|
10
|
+
### TL;DR;
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
git clone git@github.com/questdb/ui.git
|
|
14
|
+
cd ui
|
|
15
|
+
docker run -p 9000:9000 -p 9009:9009 -p 8812:8812 questdb/questdb
|
|
16
|
+
yarn
|
|
17
|
+
yarn workspace @questdb/web-console start
|
|
18
|
+
```
|
|
2
19
|
|
|
3
20
|
## Prerequisites
|
|
4
21
|
|
|
5
|
-
|
|
6
|
-
[nvm](https://github.com/nvm-sh/nvm)
|
|
7
|
-
|
|
22
|
+
* use node v16.13.1<br>
|
|
23
|
+
version is specified in [`.nvmrc`](./.nvmrc) file. You can use [nvm](https://github.com/nvm-sh/nvm) or [fnm](https://fnm.vercel.app) to manage node versions on your machine.
|
|
24
|
+
* monorepo is managed with [yarn@3](https://yarnpkg.com/).<br>
|
|
25
|
+
Follow [official installation guide](https://yarnpkg.com/getting-started/install). It should be enough to run `corepack enable` to have `yarn` enabled.
|
|
26
|
+
* This package is a frontend client for QuestDB. Therefore, it requires
|
|
27
|
+
a locally running QuestDB instance. Check [readme.md](https://github.com/questdb/questdb#install-questdb) of QuestDB to learn how to install it.<br>
|
|
28
|
+
If you have docker, then it's simply:
|
|
29
|
+
```
|
|
30
|
+
docker run -p 9000:9000 -p 9009:9009 -p 8812:8812 questdb/questdb
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Start development environment
|
|
34
|
+
|
|
35
|
+
1. Setup dependencies with yarn:
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
yarn
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
2. Start development environment
|
|
42
|
+
|
|
43
|
+
```
|
|
44
|
+
yarn workspace @questdb/web-console start
|
|
45
|
+
```
|
|
8
46
|
|
|
9
|
-
|
|
47
|
+
3. Open [localhost:9999](http://localhost:9999)
|
|
10
48
|
|
|
11
|
-
|
|
49
|
+
> make sure you have a local QuestDB instance running, as mentioned in
|
|
50
|
+
> "Prerequisites" above.
|
|
12
51
|
|
|
13
|
-
|
|
14
|
-
2. Start the development web server with `npm start`
|
|
52
|
+
4. Happy hacking!
|
|
15
53
|
|
|
16
|
-
|
|
17
|
-
[localhost:9999](http://localhost:9999)
|
|
54
|
+
## Run build
|
|
18
55
|
|
|
19
|
-
|
|
56
|
+
1. Make sure dependencies are set up:
|
|
20
57
|
|
|
21
|
-
|
|
58
|
+
```
|
|
59
|
+
yarn
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
2. Run `build` script:
|
|
22
63
|
|
|
23
64
|
```
|
|
24
|
-
|
|
65
|
+
yarn workspace @questdb/web-console run build
|
|
25
66
|
```
|
|
67
|
+
|
|
68
|
+
3. Build process emits static HTML, CSS and JS files in `packages/web-console/dist`
|