docs: add Node.js/npm prerequisites to build instructions#128
Merged
Conversation
The `cargo make dev-example` task depends on `npm run build:css` for Tailwind CSS, but the README didn't mention installing Node.js/npm or running `npm install` in the `ui/` directory. New contributors following the documented steps would hit a confusing failure. Closes #120 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
1 participant
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.
Problem
The README's "Building and Running the UI" section lists Rust, cargo-make, and dioxus-cli as prerequisites but doesn't mention Node.js/npm. The
cargo make dev-exampletask depends onbuild-tailwind, which runsnpm run build:cssin theui/directory. Anyone following the documented steps on a fresh clone gets a confusing failure when npm isn't installed or whennode_modulesis missing.Approach
cd ui && npm install && cd ..step beforecargo make dev-exampleTesting
Verified the instructions are consistent with
Makefile.tomltask graph (dev-example→build-tailwind→npm run build:cssin./ui) andui/package.jsondevDependencies.Closes #120
[AI-assisted - Claude]