Duncan Tourolle
e1e50d51e0
All checks were successful
🏗️ Build and Test JellyTau / Run Tests (pull_request) Successful in 4m1s
Traceability Validation / Check Requirement Traces (pull_request) Successful in 21s
Build & Release / Run Tests (push) Successful in 4m6s
🏗️ Build and Test JellyTau / Build Android APK (pull_request) Successful in 18m52s
Build & Release / Build Linux (push) Successful in 16m22s
Build & Release / Build Android (push) Successful in 19m13s
Build & Release / Create Release (push) Successful in 10s
61 lines
1.8 KiB
Markdown
61 lines
1.8 KiB
Markdown
<h1 align="center">
|
|
<img src="docs/assets/logo.png" alt="JellyTau logo" width="120" /><br />
|
|
JellyTau
|
|
</h1>
|
|
|
|
A cross-platform Jellyfin client built with Tauri, SvelteKit, and TypeScript.
|
|
|
|
Business logic lives in a Rust backend; a UI-rich Svelte frontend handles
|
|
presentation and talks to it over Tauri's IPC. Targets Linux (libmpv) and
|
|
Android (ExoPlayer).
|
|
|
|
## Getting Started
|
|
|
|
This project uses [bun](https://bun.sh) as its package manager.
|
|
|
|
```bash
|
|
# Activate the Rust environment (fish shell)
|
|
source "$HOME/.cargo/env.fish"
|
|
|
|
# Install dependencies
|
|
bun install
|
|
|
|
# Run in development
|
|
bun run tauri dev
|
|
|
|
# Type-check the frontend
|
|
bun run check
|
|
|
|
# Build for Linux
|
|
bun run tauri build
|
|
|
|
# Build for Android
|
|
bun run tauri android build
|
|
```
|
|
|
|
For the full set of build, test, and Android helper scripts, see
|
|
[scripts/README.md](scripts/README.md).
|
|
|
|
## Documentation
|
|
|
|
| Topic | Location |
|
|
|-------|----------|
|
|
| Architecture overview & subsystem docs | [docs/architecture/](docs/architecture/) |
|
|
| Requirements, traceability & technical debt | [docs/requirements.md](docs/requirements.md) |
|
|
| Build & release process | [docs/build-release.md](docs/build-release.md) |
|
|
| Docker builds | [docs/build/docker.md](docs/build/docker.md) |
|
|
| Traceability tooling & CI | [docs/traceability.md](docs/traceability.md), [docs/traceability-ci.md](docs/traceability-ci.md) |
|
|
| Release checklist | [docs/release-checklist.md](docs/release-checklist.md) |
|
|
| UX flows | [docs/ux-flows.md](docs/ux-flows.md) |
|
|
|
|
## Recommended IDE Setup
|
|
|
|
[VS Code](https://code.visualstudio.com/) +
|
|
[Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) +
|
|
[Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) +
|
|
[rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer).
|
|
|
|
## License
|
|
|
|
MIT
|