Skip to content

development.md

Latest commit

 

History

History
54 lines (36 loc) · 1.13 KB

development.md

File metadata and controls

54 lines (36 loc) · 1.13 KB
Raw

Development

Voyager is a Phoenix app that ships as a desktop app through Tauri.

Prerequisites

Required Elixir, Erlang, Node.js, and Rust versions are pinned in .tool-versions. The desktop app also needs the Tauri CLI:

cargo install tauri-cli --version "=2.8.0" --locked

Install dependencies and set up the database:

mix setup

Web app

Run the web app on its own:

mix phx.server
# or
iex -S mix phx.server

Then visit localhost:4000. SSH tunnel connections need Voyager's proxy_epmd module set at VM boot, so to try them in the web app start it with dev/server.sh instead.

Desktop app

Run the desktop application in development:

mix tauri.dev

To build and open the production desktop app locally:

mix assets.deploy
mix tauri.app

To tell a locally built desktop app apart from a release, set VOYAGER_DEV_BUILD=true in rel/app/.env (see .env.sample). Apps built or run through mix tauri.* then show a Dev Build banner.

Before opening a pull request

mix precommit