Webclient for the GDI-Berlin Metadateneditor

---

This documentation uses bun as a JavaScript runtime. In most cases this can be replaced with npm if bun does not work as expected.

Requirements

Install the required packages.

bun install

Generate an auth secret which encrypts tokens. Learn more

bunx auth secret

Development

bun run dev

# or start the server and open the app in a new browser tab
bun run dev -- --open

If typing gets messed up in your IDE you can regenerate them with:

bun run check

paraglide i18n

⚠️ currently the vite plugin for paraglide is not compatible with the podman setup! You may need to restart the server to use translations as expected.

Translations can be added to the messages/de.json. To use translations just import * as m from '$lib/paraglide/messages' and use it via function call. e.g: m.title()

Settings for paraglide can be adjusted in the project.inlang/settings.json.

Testing

To run the test execute.

bun test

Tests are run via the build in bun testsuite. There is a test script in the package.json so using npm run test should also work aslong as bun is installed.

Building

To create a production version of your app:

bun run build

You can preview the production build with bun run preview.

To deploy your app, you may need to install an adapter for your target environment.