A minimal Electron application

Usage no npm install needed!

<script type="module">
  import omie from '';


Omi Electron

Build cross platform desktop apps with Omi.js and Electron.js


Made with ❤︎ by Eno Yao

NPM version MIT License Linux Build Window Build

To Use

最新版本下载: Win版本 | 源文件版本

最新版本下载: Mac版本 | 源文件版本

The latest stable download: Win Version | Source Code

The latest stable download: Mac Version | Source Code


Unzip the downloaded compressed file and install it into the system. Double-click the application icon to start the application, click the green button in the middle of the application, select the development directory of your Omi project (usually under the src folder), switch to your IDE, and create or edit the file with the suffix of .omi under the development directory of your project. The file will be automatically compiled into .js file.

About Electron

Clone and run for a quick way to see Electron in action.

This is a minimal Electron application based on the Quick Start Guide within the Electron documentation.

Use this app along with the Electron API Demos app for API code examples to help you get started.

A basic Electron application needs just these files:

  • package.json - Points to the app's main file and lists its details and dependencies.
  • main.js - Starts the app and creates a browser window to render HTML. This is the app's main process.
  • index.html - A web page to render. This is the app's renderer process.

You can learn more about each of these components within the Quick Start Guide.

To Develop

1. The first method:

# Install this module from npm
npm install omie
# Go into the repository
cd node_modules/omie
# Install dependencies
npm install
# Run the app
npm start

2. The second method:

To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
git clone
# Go into the repository
cd omi-electron
# Install dependencies
npm install
# Run the app
npm start

Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

Resources for Learning Electron


MIT (Public Domain)