Back
gh

blackboardsh/electrobun: Build ultra fast, tiny, and cross-platform desktop apps with Typescript.

Build ultra fast, tiny, and cross-platform desktop apps with Typescript. - blackboardsh/electrobun

by blackboardsh github.com 861 words
View original

Logo

Electrobun

Get started with a template
**npx electrobun init**

What is Electrobun?

Electrobun aims to be a complete solution-in-a-box for building, updating, and shipping ultra fast, tiny, and cross-platform desktop applications written in Typescript. Under the hood it uses bun to execute the main process and to bundle webview typescript, and has native bindings written in zig.

Visit https://blackboard.sh/electrobun/ to see api documentation, guides, and more.

Project Goals

Apps Built with Electrobun

Video Demos

Audio TTS Demo

Co(lab) Demo

DOOM Demo

Star History

Star History Chart

Contributing

Ways to get involved:

Development Setup

Building apps with Electrobun is as easy as updating your package.json dependencies with npm add electrobun or try one of our templates via npx electrobun init.

This section is for building Electrobun from source locally in order to contribute fixes to it.

Prerequisites

macOS:

Windows:

Linux:

On Ubuntu/Debian based distros: sudo apt install build-essential cmake pkg-config libgtk-3-dev libwebkit2gtk-4.1-dev libayatana-appindicator3-dev librsvg2-dev

First-time Setup

git clone --recurse-submodules https://github.com/blackboardsh/electrobun.git
cd electrobun/package
bun install
bun dev:clean

Development Workflow

# All commands are run from the /package directory
cd electrobun/package

# After making changes to source code
bun dev

# If you only changed kitchen sink code (not electrobun source)
bun dev:rerun

# If you need a completely fresh start
bun dev:clean

Additional Commands

All commands are run from the /package directory:

Debugging

macOS: Use lldb <path-to-bundle>/Contents/MacOS/launcher and then run to debug release builds

Platform Support

OSStatus
macOS 14+Official
Windows 11+Official
Ubuntu 22.04+Official
Other Linux distros (gtk3, webkit2gtk-4.1)Community