@questdb/web-console 0.0.6 → 0.0.8
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 +51 -26
- package/dist/qdb.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,49 +7,74 @@ Yarn@3 and Webpack.
|
|
|
7
7
|
|
|
8
8
|
## Local development setup
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
You need to do the following steps:
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
12
|
+
1. Clone the repository
|
|
13
|
+
2. Bootstrap dependencies
|
|
14
|
+
3. Start development server
|
|
15
|
+
4. Run QuestDB in the background
|
|
16
|
+
5. Hack!
|
|
17
|
+
|
|
18
|
+
The setup is fairly quick!
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
### 1. Clone the repository
|
|
21
21
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
22
|
+
The repository is about 250MB in size. This is expected, because we use [Yarn@3 with PnP](https://next.yarnpkg.com/features/pnp).\
|
|
23
|
+
Download is what takes the most amount of time (~1 minute on a decent connection).
|
|
24
|
+
|
|
25
|
+
* clone using SSH:
|
|
26
|
+
```
|
|
27
|
+
git clone git@github.com/questdb/ui.git
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
* or using HTTPS:
|
|
29
31
|
```
|
|
30
|
-
|
|
32
|
+
git clone git@github.com/questdb/ui.git
|
|
31
33
|
```
|
|
32
34
|
|
|
33
|
-
|
|
35
|
+
* or using [Github CLI](https://cli.github.com/):
|
|
36
|
+
```
|
|
37
|
+
gh repo clone questdb/ui
|
|
38
|
+
```
|
|
34
39
|
|
|
35
|
-
|
|
40
|
+
### 2. Bootstrap dependencies
|
|
41
|
+
|
|
42
|
+
* `node -v` should return `16.13.1`\
|
|
43
|
+
If it doesn't, you can use [fnm](https://fnm.vercel.app) or [nvm](https://github.com/nvm-sh/nvm) to manage node versions on your machine.\
|
|
44
|
+
Then run `fnm use` or `nvm use` to set correct version.
|
|
45
|
+
|
|
46
|
+
* `yarn -v` should return v3 (like `3.2.1`).\
|
|
47
|
+
If it returns `command not found`, enable `yarn` by running `corepack enable`.\
|
|
48
|
+
Follow [official installation guide](https://yarnpkg.com/getting-started/install) if you have trouble.
|
|
49
|
+
|
|
50
|
+
* run `yarn` to bootstrap dependencies. This should be a quick process (less than a minute).
|
|
51
|
+
|
|
52
|
+
### 3. Start development server
|
|
36
53
|
|
|
37
54
|
```
|
|
38
|
-
yarn
|
|
55
|
+
yarn workspace @questdb/web-console start
|
|
39
56
|
```
|
|
40
57
|
|
|
41
|
-
|
|
58
|
+
[localhost:9999](http://localhost:9999) should show web console
|
|
59
|
+
|
|
60
|
+
### 4. Run QuestDB in the background
|
|
61
|
+
|
|
62
|
+
This package is a only GUI for QuestDB, it does not include QuestDB itself.\
|
|
63
|
+
GUI will work without it, but since it's a tool to interact with QuestDB, you will need QuestDB as well.
|
|
64
|
+
|
|
65
|
+
Check [readme.md](https://github.com/questdb/questdb#install-questdb) of QuestDB to learn how to install it.
|
|
66
|
+
|
|
67
|
+
If you have [`docker`](https://docs.docker.com/get-docker/), then it's simply:
|
|
42
68
|
|
|
43
69
|
```
|
|
44
|
-
|
|
70
|
+
docker run -p 9000:9000 -p 9009:9009 -p 8812:8812 questdb/questdb
|
|
45
71
|
```
|
|
46
72
|
|
|
47
|
-
|
|
73
|
+
### 5. Hack!
|
|
48
74
|
|
|
49
|
-
|
|
50
|
-
> "Prerequisites" above.
|
|
75
|
+
Do your code changes and browser will automatically refresh [localhost:9999](http://localhost:9999).
|
|
51
76
|
|
|
52
|
-
|
|
77
|
+
Happy hacking!
|
|
53
78
|
|
|
54
79
|
## Run build
|
|
55
80
|
|