docs: README update setup instructions [skip rust]#1
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the repository’s README to document the required local development workflow for running the Tauri GUI with the Rust daemon sidecar present, aligning the setup steps with how the project is configured (externalBin in Tauri).
Changes:
- Added a Local Development section describing the sidecar build requirement and where the binary must be placed.
- Documented platform-specific sidecar build scripts (PowerShell/Bash) and the
npm run tauri devworkflow. - Added a short explanation of why the sidecar must be built/copied manually (Tauri
externalBin+ target-triple naming).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Local Development | ||
|
|
||
| To run this project in development, you **must build the sidecar (the Rust daemon) yourself first**. |
Comment on lines
+40
to
76
| To run this project in development, you **must build the sidecar (the Rust daemon) yourself first**. | ||
|
|
||
| The Tauri `dev` command manages the frontend and the GUI wrapper, but it expects the background daemon to already exist with a specific platform-triple suffix in the `gui/src-tauri/` directory. | ||
|
|
||
| ### Setup Instructions | ||
|
|
||
| 1. **Build the Sidecar (Mandatory First Step):** | ||
| Open a terminal in the root of the project and run the platform-appropriate script. This builds the daemon and copies it to the correct location with the necessary platform suffix (e.g., `daemon-x86_64-pc-windows-msvc.exe`). | ||
|
|
||
| * **Windows (PowerShell):** | ||
| ```powershell | ||
| ./scripts/build-sidecar.ps1 | ||
| ``` | ||
| * **Linux/macOS (Bash):** | ||
| ```bash | ||
| chmod +x ./scripts/build-sidecar.sh | ||
| ./scripts/build-sidecar.sh | ||
| ``` | ||
|
|
||
| 2. **Install Frontend Dependencies:** | ||
| Navigate to the `gui` directory and install the Node.js packages. | ||
| ```bash | ||
| cd gui | ||
| npm install | ||
| ``` | ||
|
|
||
| 3. **Run the Application in Dev Mode:** | ||
| While inside the `gui` folder, start the Tauri development server. This will launch the Vite frontend and the Tauri Rust runner simultaneously. | ||
| ```bash | ||
| npm run tauri dev | ||
| ``` | ||
|
|
||
| ### Why you have to build it yourself: | ||
| The `tauri.conf.json` defines `daemon` as an `externalBin`. Tauri requires these binaries to be present at compile-time with their target triple in the filename. The provided scripts automate the `cargo build`, renaming, and moving processes required for the sidecar to be recognized by the Tauri bundler. | ||
|
|
||
|
|
||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.