Electron ImGui (EmGui) - Experimental

Electron ImGui (EmGui) is a minimal boilerplate for writing Desktop (Realtime) Graphics Applications using Electron, imgui-js, React, Webpack & TypeScript.

Screenshot

Core Features

• 🌟 Electron
• 🏆 ImGui (imgui-js)
• 🌀 TypeScript
• ⚛️ React
• 🛶 LESS Loader
• 🎨 CSS Loader
• 🧹 ESLint
• 📦 Electron Forge
• 🔱 Webpack & Configuration
• 🧩 Aliases for project paths
• 🎁 Package Bundling (Distribution / Release)

Installation

To install the EmGui Boilerplate you need to run following commands

# Clone repository
git clone --recurse-submodules https://github.com/codesbiome/electron-imgui

# Change to cloned repository folder
cd electron-imgui

Install dependencies using Yarn or NPM :

yarn install

Start : Development

To develop and run your application, you need to run following command.
Start electron application for development :

yarn start

Lint : Development

To lint application source code using ESLint via this command :

yarn lint

Package : Production

Customize and package your Electron app with OS-specific bundles (.app, .exe etc)

yarn package

Make : Production

Making is a way of taking your packaged application and making platform specific distributables like DMG, EXE, or Flatpak files (amongst others).

yarn make

Publish : Production

Publishing is a way of taking the artifacts generated by the make command and sending them to a service somewhere for you to distribute or use as updates. (This could be your update server or an S3 bucket)

yarn publish

Packager & Makers Configuration

This provides an easy way of configuring your packaged application and making platform specific distributables like DMG, EXE, or Flatpak files.

This configurations file is available in :

tools/forge/forge.config.js

For further information, you can visit Electron Forge Configuration