You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ui/README.md
+1-20Lines changed: 1 addition & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Database Lab Engine UI and DBLab Platform UI
1
+
# Database Lab Engine UI
2
2
3
3
## DBLab - thin database clones and database branching for faster development
4
4
@@ -15,7 +15,6 @@ As an example, cloning a 10 TiB PostgreSQL database can take less than 2 seconds
15
15
16
16
### List packages:
17
17
18
-
-`@postgres.ai/platform` - platform version of UI
19
18
-`@postgres.ai/ce` - community edition version of UI
20
19
-`@postgres.ai/shared` - common modules
21
20
@@ -29,32 +28,15 @@ At the root:
29
28
#### Examples
30
29
-`npm ci -ws` - install deps of all packages
31
30
-`npm run build -ws` - build all packages
32
-
-`npm run start -w @postgres.ai/platform` - run platform UI locally in dev mode
33
31
-`npm run start -w @postgres.ai/ce` - run community edition UI locally in dev mode
34
32
35
33
_Important note: don't use commands for `@postgres.ai/shared` - it's dependent package, which can't be running or built_
36
34
37
-
### How to start Platform UI with a predefined JWT token
38
-
-`cd ui/packages/platform`
39
-
-`cp .env_example_dev .env`
40
-
- edit `.env` setting:
41
-
-`REACT_APP_API_URL_PREFIX` to point to dev API server (e.g., staging API server: `https://v2.postgres.ai/api/general`).
42
-
-`REACT_APP_TOKEN_DEBUG` to have your JWT ready work with the same server. Note that it has an expiration date so it needs to be periodically refreshed.
43
-
-`pnpm install` - to install packages if they are not found
44
-
-`pnpm run start` - start Platform for local debugging/development
45
-
46
35
### How to start "ce"
47
36
-`cd ui`
48
37
-`npm ci -ws` - install dependencies, must be done once to install dependencies for all packages
49
38
-`npm run start -w @postgres.ai/ce` - start dev server
50
39
51
-
### How to build "platform"
52
-
53
-
-`cd ui`
54
-
-`npm ci -ws` - install dependencies, must be done once to install dependencies for all packages
55
-
-`source packages/platform/deploy/configs/production.sh` - set up environment variables, should be run for each new terminal session
56
-
-`npm run build -w @postgres.ai/platform`
57
-
58
40
### How to build "ce"
59
41
60
42
-`cd ui`
@@ -91,5 +73,4 @@ Ways to resolve (ordered by preference):
91
73
## Moving to Typescript
92
74
-`@postgres.ai/shared` is written on Typescript
93
75
-`@postgres.ai/ce` is written on Typescript
94
-
-`@postgres.ai/platform` is written on JavaScript and patially on Typescript. The target - is moving `@postgres.ai/platform` to Typescript fully. It should takes approximately 120-160 hours.
95
76
- There are potential problems with typing - old versions of packages may don't have their typings. Recommended to update them or replace. If it's impossible you can write your own typing in file named like `<package-name>.d.ts` inside `src` directory of the selected package.
0 commit comments