Contributing

Web client

The dashboard is a single-page app in web/. Vite serves it in development, and ferryd serves it in production.

In development, Vite serves web/src with hot reload. It sends the API calls to ferryd.

1 / 3

The dashboard is a single-page app in web/, with its own toolchain. ferryd serves it at /.

The Rust build never runs Node. ferry-api embeds what web/dist contains when it compiles.

Start the dev server

Terminal

FERRY_API_URL=http://127.0.0.1:7878 npm run dev    # → http://localhost:5173

Before you push

Run the checks of each part that you changed: Rust, the dashboard and the docs.

The development loop

Run ferryd for the API and Vite for the dashboard. Then each change of the code shows in the browser.