fix: add missing commands to quickstart #665
Merged
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.
Relates to:
#337
Risks
Low
Background
What does this PR do?
1. Add a "Build Local Libraries" Step:
Included the
pnpm build
step in the quickstart guide to address an issue where running pnpm start would fail due to missing imported libraries. This ensures the project is properly built before starting.2. Improve better-sqlite3 Troubleshooting Instructions:
Added
pnpm store prune
as a troubleshooting step for resolving issues with better-sqlite3.Deleting the pnpm-lock.yaml file is unnecessary since the library versions remain consistent. The root cause is related to the
pnpm
cache retaining an incompatible version of the package, which occurs when using a different Node.js version during the initial installation.What kind of change is this?
Improve docs
Why are we doing this? Any context or related work?
Got stuck while following the quickstart, saw other people had the same problem.
Discord username
aguspunk