odc-client
所属分类:数据库系统
开发工具:TypeScript
文件大小:0KB
下载次数:0
上传日期:2023-08-29 08:25:07
上 传 者:
sh-1993
说明: OceanBase开发中心客户端,
(OceanBase Developer Center Client,)
文件列表:
.editorconfig (245, 2023-12-26)
.eslintignore (167, 2023-12-26)
.eslintrc.js (813, 2023-12-26)
.licenserc.yaml (211, 2023-12-26)
.must.config.js (105, 2023-12-26)
.npmrc (188, 2023-12-26)
.prettierignore (56, 2023-12-26)
.prettierrc (175, 2023-12-26)
.secignore (2086, 2023-12-26)
LEGAL.md (573, 2023-12-26)
LICENSE (11357, 2023-12-26)
build/ (0, 2023-12-26)
build/electron-build.config.js (1839, 2023-12-26)
build/icon.ico (101204, 2023-12-26)
build/icon.png (51333, 2023-12-26)
build/icons/ (0, 2023-12-26)
build/icons/1024x1024.png (51333, 2023-12-26)
build/icons/256x256.png (10605, 2023-12-26)
build/icons/512x512.png (25782, 2023-12-26)
build/webpack.base.config.js (389, 2023-12-26)
build/webpack.main.config.js (765, 2023-12-26)
build/webpack.main.prod.config.js (230, 2023-12-26)
config/ (0, 2023-12-26)
config/config.client.js (474, 2023-12-26)
config/config.js (2371, 2023-12-26)
config/define/ (0, 2023-12-26)
config/define/client.js (78, 2023-12-26)
config/define/default.js (75, 2023-12-26)
config/defineConfig.js (218, 2023-12-26)
config/routes.js (3066, 2023-12-26)
config/theme.js (1169, 2023-12-26)
config/version.js (596, 2023-12-26)
docs/ (0, 2023-12-26)
... ...
## Development Guide
English | [中文](https://github.com/oceanbase/odc-client/blob/master/docs/README_CN.md)
### Introduction
ODC has a centralized deployment **web version** and a locally run **client version**. The web version requires ODC Server to run, while the client version automatically installs the corresponding dependencies and generates a standalone installation package.
### Project Initialization
#### Environment Requirements
1. [Nodejs](https://github.com/oceanbase/odc-client/blob/master/https://nodejs.org/zh-cn/download) 16 or above
2. [pnpm](https://github.com/oceanbase/odc-client/blob/master/https://pnpm.io/zh/installation)
3. Minimum 8GB RAM
4. (Optional, required for generating Mac client) MacOS system
#### Client Dependency Installation (Skip for Web Version)
##### ODC Server
After packaging the ODC Server Jar file, store it in the following directory:
[Build Jar](https://github.com/oceanbase/odc-client/blob/master/https://github.com/oceanbase/odc/blob/main/docs/en-US/DEVELOPER_GUIDE.md#31-jar-build-and-run)
```shell
libraries
- java
- odc.jar
- plugins
- plugin-related packages
- starters
- starter-related packages
```
```shell
pnpm run prepack jar
```
##### JRE
```shell
# Use ODC provided JRE
pnpm run prepack jre
```
##### OBClient
```shell
# Use ODC provided OBClient
pnpm run prepack obclient
```
#### Install Dependencies
```shell
pnpm install
```
#### Configure ODC Server Address
Modify the `proxy` field in `config/config.js` and change the `target` attribute to the address of the ODC Server.
```shell
proxy: {
'/api/v1/webSocket/obclient': {
target: 'ODC Server Address',
ws: true,
},
'/api/': {
target: 'ODC Server Address',
},
'/oauth2/': {
target: 'ODC Server Address',
},
'/login/': {
target: 'ODC Server Address',
}
}
```
### Development
#### Web Version Development
```shell
pnpm run dev
```
This will start a web server on the default `8000` port. Access [http://localhost:8000](https://github.com/oceanbase/odc-client/blob/master/https://localhost:8000) to open ODC.
#### Client Development
ODC client is developed based on Electron. We need to start two services: the web server and the Electron server.
##### Start the Client Web Server
```shell
pnpm run dev:client
```
After it starts successfully, we can proceed to start Electron.
##### Start Electron
```shell
pnpm run start-electron
```
### Build
#### Web Version Build
```shell
pnpm run build:odc
```
The packaged artifacts can be found in `dist/renderer`.
#### Client Build
```shell
# Build for win, linux, mac
node ./scripts/client/build.js all
```
You can adjust the command parameters to selectively build different installation packages. Currently, the following types are supported:
1. **mac** - dmg installation package
2. **linux_x86** - x86_64 version deb, AppImage installation package
3. **linux_aarch64** - arm64 version deb, AppImage installation package
4. **win** - win32, win64 version installation package
5. **all** - all installation packages
近期下载者:
相关文件:
收藏者: