@@ -11,14 +11,67 @@ SPDX-License-Identifier: MPL-2.0
1111``` bash
1212git clone https://github.com/streamer45/streamkit.git
1313cd streamkit
14- cd ui && bun install && cd ..
15- just dev # starts backend + frontend with hot reload
14+ just build- ui # build the embedded web UI (required before compiling the server)
15+ just dev # starts backend + frontend with hot reload
1616```
1717
18- ** Prerequisites:** Rust 1.92+, Bun 1.3+, [ Just] ( https://github.com/casey/just ) (recommended)
18+ ** Prerequisites:** Rust 1.92+, Bun 1.3+, [ Just] ( https://github.com/casey/just )
1919
2020Run ` just --list ` to see all available commands.
2121
22+ ## Prerequisites (detailed)
23+
24+ ### System packages (Ubuntu/Debian)
25+
26+ ``` bash
27+ sudo apt install libopus-dev cmake pkg-config libssl-dev
28+ ```
29+
30+ ### Rust toolchain
31+
32+ The repo pins the toolchain via ` rust-toolchain.toml ` (currently Rust 1.92). Install Rust if you haven't already:
33+
34+ ``` bash
35+ curl --proto ' =https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
36+ ```
37+
38+ ### Bun
39+
40+ ``` bash
41+ curl -fsSL https://bun.sh/install | bash
42+ ```
43+
44+ ### Just (task runner)
45+
46+ ``` bash
47+ cargo install just
48+ ```
49+
50+ ### Linting tools
51+
52+ Required by ` just lint ` :
53+
54+ ``` bash
55+ cargo install cargo-deny
56+ pip3 install --user reuse # note: the apt version is too old
57+ ```
58+
59+ ### Development mode
60+
61+ Required by ` just dev ` :
62+
63+ ``` bash
64+ cargo install cargo-watch
65+ ```
66+
67+ ### Native plugin development (optional)
68+
69+ Building ML plugins (e.g. whisper, sensevoice) requires additional dependencies:
70+
71+ ``` bash
72+ sudo apt install clang libclang-dev
73+ ```
74+
2275## Making Changes
2376
24771 . Create a branch: ` git checkout -b feat/my-feature ` or ` fix/my-bug `
0 commit comments