https://github.com/blackboardsh/electrobun
Build ultra fast, tiny, and cross-platform desktop apps with Typescript.
https://github.com/blackboardsh/electrobun
Last synced: 2 months ago
JSON representation
Build ultra fast, tiny, and cross-platform desktop apps with Typescript.
- Host: GitHub
- URL: https://github.com/blackboardsh/electrobun
- Owner: blackboardsh
- License: mit
- Created: 2024-02-28T03:18:15.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-12T16:04:41.000Z (7 months ago)
- Last Synced: 2024-09-13T05:04:55.025Z (7 months ago)
- Language: Zig
- Homepage: https://www.electrobun.dev
- Size: 89.4 MB
- Stars: 233
- Watchers: 8
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- stars - electrobun - platform desktop apps with Typescript. | blackboardsh | 1868 | (Zig)
- stars - electrobun - platform desktop apps with Typescript. | blackboardsh | 1677 | (Zig)
README
Electrobun
## What is Electrobun?
> Electrobun is in the **_very_** early stages. We currently only support development on arm macs, it has memory leaks, has no tests, and many core things are still missing. We're actively working on adding Windows and Linux support.
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 Electrobun.dev to see api documentation, guides, and more.
**Project Goals**
- Write typescript for the main process and webviews without having to think about it.
- Isolation between main and webview processes with fast, typed, easy to implement RPC between them.
- Small self-extracting app bundles ~12MB (when using system webview, most of this is the bun runtime)
- Even smaller app updates as small as 4KB (using bsdiff it only downloads tiny patches between versions)
- Provide everything you need in one tightly integrated workflow to start writing code in 5 minutes and distribute in 10.
## Architecture
Read about how Electrobun is designed, and why, in our architecture docs.
## Roadmap
See the roadmap
## Contributing
On the road to a stable 1.0.0 I'm probably going to just be pushing directly to main a lot.
As we get closer to 1.0.0 I'll probably make guidelines for PRs and stuff. In the meantime if you find this project and want to contribute code it's probably best to create an issue first or ping me on twitter or discord to discuss when, what, and how is best to do that.
Ways to get involved at this early stage:
- Follow us on X for updates @BlackboardTech or @yoav.codes
- Join the conversation on Discord
- Create and participate in Github issues and discussions
## Building
### MacOS
First make sure you have:
- xcode tools
- cmake (can install via homebrew)
- run `bun run install-zig` to install the right version of zig to vendors/zig
`bun dev:playground` and `bun dev:playground:canary` will compile everything in electrobun in either dev mode and then compile the playground app in either dev or canary modes and run it.
Note: use `lldb /Contents/MacOS/launcher` and then `run` to debug release builds