ContributingWeb client

The development loop

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

Start ferryd. The dev server needs only the API of ferryd.

1 / 4

Run ferryd as in Start the server.

The dev server needs only the API of ferryd. The dashboard that ferryd embeds does not matter.

Terminal

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

Vite serves the app with hot module replacement. The dev proxy sends the API calls to FERRY_API_URL.

Open http://localhost:5173. Sign in with the email and the password of the account of the server.

Web client

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

The npm scripts

Six npm scripts in web/ run the dev server, the tests, the checks and the build.