docs: add fallback npm install:ci instructions to README #1325
+6
−0
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.
Context
Added fallback installation instructions to the README.md to address dependency issues when setting up the project locally. The
npm run install:all
command fails for first-time setup because it requires the npm-run-all package to be installed first.Implementation
Updated the README.md file in the "Local Setup & Development" section to include a fallback instruction that directs users to run
npm run install:ci
if the initialnpm run install:all
command fails.This approach provides a better developer experience by:
npm run install:all
as the primary instruction for most usersThe
install:ci
script first installs the npm-run-all package before running the install:all script, which resolves the dependency issue without requiring changes to the core build scripts.How to Test
npm run install:all
- you should see an error about npm-run-all not being foundnpm run install:ci
- this should successfully install all dependenciesGet in Touch
Discord: @KJ7LNW
Important
Adds fallback npm install instructions to
README.md
for dependency issues during local setup.README.md
in "Local Setup & Development" section.npm run install:ci
ifnpm run install:all
fails due to missingnpm-run-all
package.This description was created by
for 5ee9b32. It will automatically update as commits are pushed.