# opensumi-web

**Repository Path**: himo/opensumi-web

## Basic Information

- **Project Name**: opensumi-web
- **Description**: 基于opensumi集成开发demo
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-06-20
- **Last Updated**: 2022-06-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# opensumi集成demo效果图
![image](./1.png)

## OpenSumi Web 集成示例
![Docker Image CI](https://github.com/opensumi/ide-startup/actions/workflows/docker-image.yml/badge.svg)

本项目为基于 OpenSumi 框架的 Web 版 IDE 集成示例

### 项目结构

```bash
.
├── workspace                   # 工作目录
├── extensions                  # 插件目录
├── configs                     # webpack 配置
├── src
│   ├── browser
│   └── node
├── tsconfig.json
├── package.json
└── README.md
```

### 启动

```bash
$ git clone https://gitee.com/yangshundegit/opensumi-web.git
$ cd opensumi-web
$ yarn              # 安装依赖后会自动执行 prepare，编译 Node.js 和 WebWorker 两个插件环境, 下载默认插件
$ mkdir workspace   # 创建默认的 workspace 目录，启动后会默认打开该目录
$ yarn start        # 启动前端、后端服务器及 Webview Host
```

浏览器打开 `http://0.0.0.0:8080`

URL 添加 query 参数 `workspaceDir` 即可打开指定目录，例如 `http://0.0.0.0:8080?workspaceDir=/path/to/dir`

![OpenSumi](./snapshots/sumi-startup.png)

### 使用 Docker 镜像

```bash
# 拉取镜像
docker pull ghcr.io/opensumi/opensumi-web:latest

# 运行
docker run --rm -d  -p 8080:8000/tcp ghcr.io/opensumi/opensumi-web:latest
```

浏览器打开 `http://0.0.0.0:8080`