@codeblitzjs/ide-code-api v1.1.0

code-api

English | 简体中文

Code Service Integration API

How to Develop

Github

• Configure PrivateToken by yourself
• API Reference
  1. Github REST API
  2. Github GraphQL API

GitLab

• Provide basic code service API for self-integration. Modify the default configuration in packages/code-api/src/common/config.ts
• GitLab API

• Local Development

  # 1. start server
  npm run start
  
  # 2. open url
  http://localhost:9009/gitlab/${group}/${name}

AtomGit

• Configure Private Token by yourself
• API Reference: AtomGit API

• Local Development

  # 1. start server
  npm run start
  # 2. set  AtomGit Token in packages/startup/src/startup/index.tsx 
  
    CodeServiceModule.Config({
      ...
      atomgit: {
        // atomgit token https://atomgit.com/-/profile/tokens
        token: 'your token'
      }
      ...
    })
  
  # 3. open url
  http://localhost:9009/atomgit/opensumi/codeblitz

GitLink

• APIReference: GitLink API
• Introduction: GitLink WebIDE
• Local Development

  # 1. set .env file
  CODE_SERVICE_HOST=https://www.gitlink.org.cn
  # 2. set gitlnk cookie  
  set Cookie in packages/toolkit/webpack/config.dev.js from https://www.gitlink.org.cn response header
  # 3. start server
  npm run start
  # 3. open url
  http://localhost:9009/gitlink/opensumi/core

Gitee

• APIReference: Gitee API
• Example: WebIDE for Gitee
• Local Development

  # 1. set Gitee Token in packages/startup/src/startup/index.tsx
      CodeServiceModule.Config({
        ...
        gitee: {
          ## set gitee file request  recursive: true
          recursive: true,
          ## gitee token https://gitee.com/profile/personal_access_tokens
          token: 'your token'
        },
        ...
    })
  # 3. start server
  npm run start
  # 3. open url
  http://localhost:9009/gitee/opensumi/codeblitz

Codeup

• APIReference: Codeup API
• Introduction: Codeup WebIDE

• Local Development

  # 1. set .env file
  CODE_SERVICE_HOST=https://codeup.aliyun.com
  # 2. set codeup cookie   
  
  set Cookie in packages/toolkit/webpack/config.dev.js from https://codeup.aliyun.com response header
  
  # 3. set codeup projectId
    codeup: {
      owner: 'your owner',
      name: 'your name',
      projectId: 'your projectId', # require
    }
  
  # 3. start server
  npm run start
  # 3. open url
  http://localhost:9009/codeup/${owner}/${name}