Skip to content

opensumi/core

Repository files navigation

CI E2E NPM Version NPM downloads Test Coverage CLA assistant License Discussions Open in CodeBlitz

OpenSumi

A framework helps you quickly build Cloud or Desktop IDE products.

perview

English | ็ฎ€ไฝ“ไธญๆ–‡

โšก๏ธ Quick Start

$ yarn install
$ yarn run init
$ yarn run download-extension  # Optional
$ yarn run start

By default, the tools/workspace folder in the project would be opened, or you can run the project by specifying the directory in the following way:

$ MY_WORKSPACE={local_path} yarn run start

Usually, you may still encounter some system-level environment dependencies. You can visit Development Environment Preparation to see how to install the corresponding environment dependencies.

๐ŸŒŸ Getting Started

Here you can find some of our example projects and templates:

๐Ÿ“• Documentation

For complete documentation: opensumi.com

๐Ÿ“ ReleaseNotes & BreakingChanges

You can see all the releasenotes and breaking changes here: CHANGELOG.md.

๐Ÿ”ฅ Contributing

Read through our Contributing Guidelines to learn about our submission process, coding rules and more.

๐Ÿ™‹โ€โ™€๏ธ Want to Help?

Want to report a bug, contribute some code, or improve documentation? Excellent! Read up on our Contributing Guidelines for contributing and then check out one of our issues labeled as help wanted or good first issue.

๐Ÿง‘โ€๐Ÿ’ป Needs some help?

Go to our issues or discussions to create a topic, it will be resolved as soon as we can.

๐Ÿ“ƒ License

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

Licensed under the MIT license.

This project contains various third-party code under other open source licenses.

See the NOTICE.md file for more information.

โœจ Contributors

โค๏ธ Thanks goes to these wonderful people!