ddidderr
d63d4b9c2f
Add a project-level setup recipe for the initial development bootstrap. The recipe installs the Tauri CLI and resolves the Tauri frontend dependencies from the Deno lockfile so new contributors have one command before running or building the app. Refresh the README to keep it short and focused on what Lanspread is, how to bootstrap it, and the most important just recipes. Test Plan: - just --summary - just --dry-run setup - git diff --check - git diff --cached --check
49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
# lanspread
|
|
|
|
Peer-to-peer game library sharing for LAN parties. Peers discover each other on
|
|
the local network via mDNS, exchange library metadata over QUIC, and let users
|
|
browse and download games from each other. Ships as a Tauri desktop app.
|
|
|
|
## Build / install
|
|
|
|
Install Rust, Deno, and `just` first, then bootstrap the project:
|
|
|
|
```bash
|
|
just setup
|
|
```
|
|
|
|
That installs the Tauri CLI with `cargo install tauri-cli` and installs the
|
|
Deno/npm dependencies from `crates/lanspread-tauri-deno-ts`.
|
|
|
|
Run the desktop app in development mode:
|
|
|
|
```bash
|
|
just run
|
|
```
|
|
|
|
Build without bundling:
|
|
|
|
```bash
|
|
just build
|
|
```
|
|
|
|
Create production bundles:
|
|
|
|
```bash
|
|
just bundle
|
|
```
|
|
|
|
## Important just commands
|
|
|
|
- `just setup` - install the Tauri CLI and frontend dependencies.
|
|
- `just run` - run the Tauri app in dev mode.
|
|
- `just build` - build the app without bundling.
|
|
- `just bundle` - create production bundles.
|
|
- `just fmt` - format Rust, TOML, and the justfile.
|
|
- `just clippy` - lint the Rust workspace.
|
|
- `just test` - run workspace tests.
|
|
- `just frontend-test` - run frontend tests.
|
|
- `just peer-cli-build` - build the JSONL peer test harness.
|
|
- `just peer-cli-image` - build the peer harness Docker image.
|
|
- `just peer-cli-run NAME` - run one peer harness container.
|