# ide-electron

**Repository Path**: opensumi/ide-electron

## Basic Information

- **Project Name**: ide-electron
- **Description**: OpenSumi Electron Version
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://opensumi.com
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-09-06
- **Last Updated**: 2023-09-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OpenSumi IDE Electron

English | [中文文档](https://opensumi.com/zh/docs/integrate/quick-start/electron)

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

## Startup

```shell
git clone git@github.com:opensumi/ide-electron.git
cd ide-electron
yarn
yarn build
yarn rebuild-native --force-rebuild=true
yarn download-extension # install extension (Optional)
yarn start
```

to use the China CDN mirror, checkout branch `main-cn`:

```shell
git checkout main-cn
```

## Develop

Start application:

```shell
yarn watch
yarn start
```

When there are new changes in the code, open the command panel in the editor <kbd>shift</kbd>+<kbd>command</kbd>+<kbd>p</kbd>, select and run the 'Reload Window' to reload the current editor window.

## package to DMG

package the project, and the installation package in the `out` directory:

```shell
yarn run pack
```