Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

chore(deps): bump url-parse from 1.5.3 to 1.5.7 in /ui#87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 54 additions & 10 deletionsui/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,90 @@
# Database Lab Engine and Database Lab Engine UI

## Database Lab - thin database clones for faster development

_Proceed to [Database Lab Engine repository](https://gitlab.com/postgres-ai/database-lab) for more information about technology itself._
Database Lab Engine (DLE) is an open-source (AGPLv3) technology that allows blazing-fast cloning of Postgres databases of any size in seconds. This helps solve many problems such as:

- build dev/QA/staging environments involving full-size production-like databases,
- provide temporary full-size database clones for SQL query analysis optimization,
- automatically verify database migrations (DB schema changes) and massive data operations in CI/CD pipelines to minimize risks of downtime and performance degradation.

As an example, cloning a 10 TiB PostgreSQL database can take less than 2 seconds.

## Development

### List packages:

- `@postgres.ai/platform` - platform version of UI
- `@postgres.ai/ce` - community edition version of UI
- `@postgres.ai/shared` - common modules

### How to operate

At the root:

- `<npm command> -ws` - for all packages
- `<npm command> -w <package-name>` - for specific package

#### Examples

- `npm ci -ws` - install deps of all packages
- `npm build -ws` - build all packages
- `npm start -w @postgres.ai/platform` - run platform UI locally in dev mode
- `npm start -w @postgres.ai/ce` - run community edition UI locally in dev mode
- `npmrunbuild -ws` - build all packages
- `npmrunstart -w @postgres.ai/platform` - run platform UI locally in dev mode
- `npmrunstart -w @postgres.ai/ce` - run community edition UI locally in dev mode

_Important note: don't use commands for `@postgres.ai/shared` - it's dependent package, which can't be running or built_

### How to start
- `npm ci -ws`
- `npm start -w @postgres.ai/platform` or `npm start -w @postgres.ai/ce`
### How to start "platform"

- `cd ui`
- `npm ci -ws` - install dependencies, must be done once to install dependencies for all packages
- `source packages/platform/deploy/configs/production.sh` - set up environment variables, should be run for each new terminal session
- `npm run start -w @postgres.ai/platform` - start dev server
- To sign in locally - sign in on [console.postgres.ai](https://console.postgres.ai) and copy `token` from Local Storage to your localhost's Local Storage

### How to start "ce"

### How to build
- `npm ci -ws`
- `npm build -ws`
- `cd ui`
- `npm ci -ws` - install dependencies, must be done once to install dependencies for all packages
- `npm run start -w @postgres.ai/ce` - start dev server

### How to build "platform"

- `cd ui`
- `npm ci -ws` - install dependencies, must be done once to install dependencies for all packages
- `source packages/platform/deploy/configs/production.sh` - set up environment variables, should be run for each new terminal session
- `npm run build -w @postgres.ai/platform`

### How to build "ce"

- `cd ui`
- `npm ci -ws` - install dependencies, must be done once to install dependencies for all packages
- `npm run build -w @postgres.ai/ce` - start dev server

### CI pipelines for UI code

To deploy UI changes, tag the commit with `ui/` prefix and push it. For example:

```shell
git tag ui/1.0.12
git push origin ui/1.0.12
```

<!-- TODO: move this ^ to the main README.md and CONTRIBUTING.md -->
## Vulnerability issues
Vulnerabilities, CVEs, security issues can be reported on GitLab or on GitHub by various tools/bots we use to ensure that DLE code is safe and secure. They may be of various kinds – here we consider two types, a known CVE reported for particular package we use for DLE UI code during analysis of dependencies, and some issue in code that was detected by a static analysis tool.

### Packages issues
Ways to resolve (ordered by preference in descending order):
1. Update a package - try to look for a newer package in npm, probably this vulnerability is already fixed.
2. If vulnerability is detected in a sub-package - try to replace it using [npm-force-resolutions](https://www.npmjs.com/package/npm-force-resolutions). Be careful using this way - it may break a project as in a build phase as at runtime. Full e2e definitely should be done in this case.
3. Fork the package and put it locally in this repo.
4. If you are sure this is a falsy vulnerability - try to ignore it using special commands for your SAST tool. **This is considered as the least preferable option – try to apply any of the ways described above first.**

### Code issues
Ways to resolve (ordered by preference):
1. If the part of source code is written on `.js` try to rewrite it on `.ts` or `.tsx` - it should fix a lot of potential security issues.
2. Follow the recommendations of your SAST tool - fix it manually or automatically.
3. If you are sure this is a falsy vulnerability - try to ignore it using special commands for your SAST tool. **This is considered as the least preferable option – try to apply any of the ways described above first.**

<!-- TODO: move this ^ to the main README.md and CONTRIBUTING.md -->
1 change: 1 addition & 0 deletionsui/cspell.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,7 @@
"craco",
"Formik",
"healthz",
"SAST",
"rehype"
]
}
Loading
[8]ページ先頭
©2009-2025 Movatter.jp