{"id":29571895,"url":"https://github.com/oceanbase/odc-client","last_synced_at":"2025-07-19T04:36:32.984Z","repository":{"id":189061444,"uuid":"638824627","full_name":"oceanbase/odc-client","owner":"oceanbase","description":"OceanBase Developer Center Client","archived":false,"fork":false,"pushed_at":"2025-07-15T02:38:51.000Z","size":23948,"stargazers_count":21,"open_issues_count":17,"forks_count":10,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-07-15T05:48:33.976Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oceanbase.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-05-10T07:26:47.000Z","updated_at":"2025-07-15T01:48:15.000Z","dependencies_parsed_at":"2023-12-25T08:23:47.809Z","dependency_job_id":"47ceaf4a-70a2-4e5b-9788-3833c587d800","html_url":"https://github.com/oceanbase/odc-client","commit_stats":null,"previous_names":["oceanbase/odc-client"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/oceanbase/odc-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oceanbase%2Fodc-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oceanbase%2Fodc-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oceanbase%2Fodc-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oceanbase%2Fodc-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oceanbase","download_url":"https://codeload.github.com/oceanbase/odc-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oceanbase%2Fodc-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265889162,"owners_count":23844539,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-19T04:36:32.344Z","updated_at":"2025-07-19T04:36:32.972Z","avatar_url":"https://github.com/oceanbase.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Development Guide\n\nEnglish | [中文](docs/README_CN.md)\n\n### Introduction\n\nODC 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.\n\n### Project Initialization\n\n#### Environment Requirements\n\n1. [Nodejs](https://nodejs.org/zh-cn/download) 16 or above\n2. [pnpm](https://pnpm.io/zh/installation)\n3. Minimum 8GB RAM\n4. (Optional, required for generating Mac client) MacOS system\n\n#### Client Dependency Installation (Skip for Web Version)\n\n##### ODC Server\n\nAfter packaging the ODC Server Jar file, store it in the following directory:\n[Build Jar](https://github.com/oceanbase/odc/blob/main/docs/en-US/DEVELOPER_GUIDE.md#31-jar-build-and-run)\n\n```shell\nlibraries\n - java\n   - odc.jar\n   - plugins\n     - plugin-related packages\n   - starters\n     - starter-related packages\n```\n\n```shell\npnpm run prepack jar\n```\n\n##### JRE\n\n```shell\n# Use ODC provided JRE\npnpm run prepack jre\n```\n\n##### OBClient\n\n```shell\n# Use ODC provided OBClient\npnpm run prepack obclient\n```\n\n#### Install Dependencies\n\n```shell\npnpm install\n```\n\n#### Configure ODC Server Address\n\nModify the `proxy` field in `config/config.js` and change the `target` attribute to the address of the ODC Server.\n\n```shell\nproxy: {\n    '/api/v1/webSocket/obclient': {\n      target: 'ODC Server Address',\n      ws: true,\n    },\n    '/api/': {\n      target: 'ODC Server Address',\n    },\n    '/oauth2/': {\n      target: 'ODC Server Address',\n    },\n    '/login/': {\n      target: 'ODC Server Address',\n    }\n  }\n```\n\n### Development\n\n#### Web Version Development\n\n```shell\npnpm run dev\n```\n\nThis will start a web server on the default `8000` port. Access [http://localhost:8000](https://localhost:8000) to open ODC.\n\n#### Client Development\n\nODC client is developed based on Electron. We need to start two services: the web server and the Electron server.\n\n##### Start the Client Web Server\n\n```shell\npnpm run dev:client\n```\n\nAfter it starts successfully, we can proceed to start Electron.\n\n##### Start Electron\n\n```shell\npnpm run start-electron\n```\n\n### Build\n\n#### Web Version Build\n\n```shell\npnpm run build:odc\n```\n\nThe packaged artifacts can be found in `dist/renderer`.\n\n#### Client Build\n\n```shell\n# Build for win, linux, mac\nnode ./scripts/client/build.js all\n```\n\nYou can adjust the command parameters to selectively build different installation packages. Currently, the following types are supported:\n\n1. **mac** - dmg installation package\n2. **linux_x86** - x86_64 version deb, AppImage installation package\n3. **linux_aarch64** - arm64 version deb, AppImage installation package\n4. **win** - win32, win64 version installation package\n5. **all** - all installation packages\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foceanbase%2Fodc-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foceanbase%2Fodc-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foceanbase%2Fodc-client/lists"}