Duncan Tourolle
5ba9e0e958
- Standardize on bun: remove package-lock.json, add packageManager field, gitignore non-bun lockfiles, fix stray npm install in android:build:clean - Remove stale build logs and empty dirs (src-tauri/plugins, docs/tickets) - Move android-dev.sh into scripts/ - Consolidate root docs into docs/ (docker/builder under docs/build/); move the architecture overview to docs/architecture/README.md - Extract Requirements Specification from README into docs/requirements.md and slim README down to a project intro + docs index - Fix internal references to the moved files
58 lines
1.7 KiB
Markdown
58 lines
1.7 KiB
Markdown
# JellyTau
|
|
|
|
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
|