Beacon Studio

Beacon Studio is a SvelteKit + Tauri application for Beacon data exploration.

Developing

Install dependencies:

npm install

Run the web app in development mode:

npm run dev

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

Run the desktop app (Tauri) in development mode:

npm run tauri:dev

Building

Build the web app (static output):

npm run build --omit=dev

Build the web app for a subdirectory deployment (example: beacon-wod.maris.nl/studio):

BASE_PATH=//studio npm run build --omit=dev

$env:BASE_PATH="/studio"; npm run build --omit=dev

Use // to prevent path lookup issues in bash.

Build downloadable desktop executables (Tauri):

npm run tauri:build

Running Production Build Locally

Preview the web production build locally:

npm run preview

Quality Checks

npm run check
npm run lint

Notes

• Static web output is generated in build/.
• BASE_PATH is read by svelte.config.js and should be set for subdirectory hosting.

Beacon client dependency:

Currently @beacon/client is not in NPM but its contained in:

https://github.com/maris-development/beacon/tree/main/beacon-clients/beacon-ts

So what we do is as follows:

• Clone beacon git repo next to where you cloned beacon-studio
• go to /beacon-clients/beacon-ts
• run npm install and npm run build

After that this project can also be built by running npm install and npm run build, and develop with the commands described in this document.