OSIPY Dashboard

Dashboard scaffold for OSIPY projects

The current version is intentionally frontend-only. Login, account creation, PocketBase, and seed scripts were removed until the dashboard needs persistence.

Tech Stack

• SvelteKit 2 and Svelte 5
• Tailwind CSS 4 and daisyUI
• Bun runtime
• Docker Compose for local development

Development

Run the app through Docker Compose with Bun:

make dev

make dev uses the fixed dashboard port 37183 and prints the URL before starting Docker Compose.

You can also run it locally without Docker:

bun install
bun run dev

Before opening a pull request, run:

bun run check
bun run lint
bun run build

Configuration

Copy .env.example to .env if you want to use Docker Compose directly with the same frontend port:

cp .env.example .env

Citation

If you use OSIPY Dashboard in your work, cite it using the metadata in CITATION.cff. Release archives can be connected to Zenodo using the metadata in .zenodo.json.

Project Practices

See CONTRIBUTING.md for the contribution workflow, SECURITY.md for vulnerability reporting, GOVERNANCE.md for decision-making and handover expectations, and docs/release.md for release notes.

License

MIT License. See LICENSE.