desktop - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #ai #android #machine-learning #linux #macos #kubernetes #pytorch #security #ios #openai #open-source

desktop

(★ 1,798)

Building Local-First apps for Windows, MacOS, Linux, iOS and Android using Phoenix LiveView & Elixir!

File Explorer

Download Latest Version (.zip)

- - ci.yml
- config.exs
- sdl-on-close-option.md
- TEST_PLAN.md
- faq.md
- getting_started.md
- your_first_desktop_app.md
- - auth.ex
  - endpoint.ex
  - env.ex
  - fallback.ex
  - image.ex
  - menu.ex
  - os.ex
  - pixmap.ex
  - platform.ex
  - tool_versions.ex
  - toolchain.ex
  - window.ex
  - wx.ex
- desktop.ex
- - bridge_codec_test.exs
  - bridge_transport_test.exs
  - env_test.exs
  - fallback_test.exs
  - guard_boolean_ops_test.exs
  - language_code_test.exs
  - menu_adapter_test.exs
  - platform_system_test.exs
  - platform_test.exs
  - tool_versions_test.exs
  - toolchain_test.exs
  - window_lifecycle_test.exs
- - desktop_case.ex
  - guard_boolean_ops.exs
  - guard_platform_abstraction.exs
  - menu_stub.ex
  - wx_case.ex
- auth_test.exs
- parser_test.exs
- test_helper.exs
- window_test.exs
.formatter.exs
.gitignore
.tool-versions
AGENTS.md
CHANGELOG.md
desktop_wx_stub.exs
LICENSE.md
mix.exs
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Desktop

[![Module Version](https://img.shields.io/hexpm/v/desktop.svg)](https://hex.pm/packages/desktop)
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/desktop/)
[![Total Download](https://img.shields.io/hexpm/dt/desktop.svg)](https://hex.pm/packages/desktop)
[![License](https://img.shields.io/hexpm/l/desktop.svg)](https://github.com/elixir-desktop/desktop/blob/master/LICENSE.md)
[![Last Updated](https://img.shields.io/github/last-commit/elixir-desktop/desktop.svg)](https://github.com/elixir-desktop/desktop/commits/master)

Building native-like Elixir apps for Windows, MacOS, Linux, iOS and Android using Phoenix LiveView!

## Example

Checkout [the example app](https://github.com/elixir-desktop/desktop-example-app) for a starting point.

![MacOS build](https://raw.githubusercontent.com/elixir-desktop/desktop-example-app/main/nodeploy/macos_todo.png 'MacOS build')

## Getting Started

Check out the [Getting your Environment Ready Guide](./guides/getting_started.md) and [Your first Desktop App](./guides/your_first_desktop_app.md).

This repo’s [`.tool-versions`](./.tool-versions) pins Erlang and Elixir for contributors; [mise](https://mise.jdx.dev/) and [asdf](https://asdf-vm.com/) both understand that file. After activating your toolchain, run `mix desktop.check_toolchain` to confirm the running OTP major and Elixir version match `.tool-versions`.

## Platform backends

`desktop` routes window, webview, menu, and notification calls through `Desktop.Platform` to one of three backends. The default is **automatic** selection (`:auto`); you can override it in config or via environment variables.

| Backend | Typical use |
|---|---|
| `Desktop.Backend.Wx` | Native windows on Windows, macOS, and Linux (OTP `:wx` / wxWidgets) |
| `Desktop.Backend.Json` | Android and iOS — JSON/TCP bridge to your native host app (`BRIDGE_PORT`) |
| `Desktop.Backend.Browser` | Headless CI, servers without wx, or local dev without a GUI (`NO_WX=1`) |

**Automatic selection** (`config :desktop, :backend, :auto` — the default):

1. Mobile target (`config :desktop, :mobile_target, true` at compile time, or `Desktop.OS.mobile?/0` at runtime) → **Json**
2. Else `NO_WX` set or `:wx` not available → **Browser**
3. Else → **Wx**

**Explicit override** in `config/config.exs`:

```elixir
config :desktop, :backend, :wx      # force wxWidgets (desktop)
config :desktop, :backend, :json   # force JSON bridge (e.g. mobile host)
config :desktop, :backend, :browser # force OS-browser fallback
config :desktop, :backend, :auto   # automatic (default)
```

You can also pass a **custom backend module** that implements the `Desktop.Platform.*` behaviour callbacks:

```elixir
config :desktop, :backend, MyApp.DesktopBackend
```

**Environment variables:**

| Variable | Effect |
|---|---|
| `NO_WX=1` | With `:auto`, selects the Browser backend (no native window) |
| `BRIDGE_PORT` | TCP port for the Json backend’s native host (default `0` = in-process mock for tests) |

See the [FAQ](./guides/faq.md) for mobile bridge setup, headless testing, and capability details.

## Status / Roadmap

1. ✅ Run elixir-desktop on Windows/MacOS/Linux
2. ✅ Run elixir-desktop on iOS/Android
3. ✅ Package elixir-desktop based apps for iOS/Android (see example-app repo for iOS and Android)
4. Package elixir-desktop based apps in installers for Windows/MacOS/Linux
5. Update the desktop example app built installers for Windows/MacOS/Linux using GitHub actions
6. Use a repo of pre-compiled Erlang binaries for Windows/MacOS/Linux/iOS/Android when building Apps, so one call of `mix desktop.deploy` will create installer for all platforms.
7. Integrate Code Signing for Windows/MacOS
8. Build a GitHub actions based auto-update flow

## Contributing and Raising Issues

- Please checkout [the GitHub repo](https://github.com/elixir-desktop/desktop) and raise any issue.
- For questions and comments best to use the [Elixir forum](https://elixirforum.com/t/elixir-desktop-android-window-macos-linux-liveview-apps-with-elixir/) or contact me on [Slack](https://elixir-lang.slack.com/archives/C02429KJJCX).

All suggestions are welcome!

Cheers!

## Copyright and License

Copyright (c) 2021 Dominic Letz

This work is free. You can redistribute it and/or modify it under the terms of the MIT License. See the [LICENSE.md](./LICENSE.md) file for more details.