OpenSumi

一款帮助你快速搭建 AI 原生 IDE 产品的底层框架。

🌟 起步项目

我们提供了一些示例项目帮助你快速搭建你的 IDE 项目产品

• Cloud IDE
• Desktop IDE - 桌面端 IDE
• CodeFuse IDE - 基于 OpenSumi 的 AI IDE
• CodeBlitz - 无容器 IDE 框架
• Lite Web IDE - 无容器 IDE
• 小程序 IDE

⚡️ 如何开发

由于国内网络访问的问题，部分包的下载安装都会比较缓慢，建议在开始前将你的 npm 镜像切换至国内 taobao 镜像地址，或安装一个 npm 镜像切换工具用于快速切换，如 nrm, 手动设置方式如下：

$ yarn config set npmRegistryServer https://registry.npmmirror.com

$ yarn
$ yarn run init
$ yarn run download-extension  # 可选
$ yarn run start

默认情况下，框架会将项目下的 tools/workspace 目录作为工作区目录展现, 同时，你也可以通过下面的命令指定你要打开的工作区路径:

$ MY_WORKSPACE={local_path} yarn run start

通常情况下，你可能还会遇到一些系统级别的环境依赖问题，你可以访问 开发环境准备 查看如何安装对应环境依赖。

📕 文档

请访问 opensumi.com

📍 更新日志及不兼容的变更

请访问 CHANGELOG.md.

🔥 如何贡献

阅读我们的 如何贡献代码 文档学习我们的开发环境配置、流程管理、编码规则等详细规则。

🙋‍♀️ 帮助我们

如果你希望反馈一个 Bug, 你可以直接在 Issues 中直接按照格式进行创建，在提供必要的复现路径和版本信息后，我们将会有相关人员进行处理。

如果你希望提交一些代码或者帮助我们优化文档，我们十分欢迎 ~ 你可以阅读详细的 如何贡献代码 文档路径如何贡献。

同时，对于 Issues 中标记了 help wanted 或者 good first issue 的问题，将会比较适合作为你的第一个 PR 来提交。

🧑‍💻 开发者交流群

我们建议你通过 issues 或 discussions 与我们进行交流。

如果你希望通过即时通讯工具（如微信、钉钉）交流，欢迎前往我们的 中文社区 页面获取最新二维码信息。

✨ 贡献者

加入我们，一起构建更好用的 OpenSumi！

在开始之前，请花点时间查看我们的贡献指南。欢迎通过 Pull Requests 或 GitHub Issues 分享您的想法。

📃 协议

Copyright (c) 2019-present Alibaba Group Holding Limited, Ant Group Co. Ltd.

本项目采用 MIT 协议。

同时，该项目也包含部分基于其他开源协议下的第三方代码，详细内容请查看 NOTICE.md 文件。