docs: add Windows development setup guide - #381
Open
dakshagarwal76 wants to merge 1 commit into
Open
Conversation
Document Windows-specific dev setup including pnpm, VS Build Tools, native module rebuild, PowerShell test commands, and troubleshooting. Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
Pull request overview
Adds a dedicated Windows development setup guide to document the required toolchain and Windows-specific workflows (native module rebuilds and running tests in PowerShell), and links it from the main contributor entry points.
Changes:
- Added
docs/windows-dev-setup.mdcovering prerequisites, native module rebuilds, PowerShell-friendly test commands, installer build, data paths, and troubleshooting. - Linked the new guide from
README.mdandCONTRIBUTING.md(including a note about Windows test commands).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Adds a Windows development setup section linking to the new guide. |
| docs/windows-dev-setup.md | New Windows-specific setup guide with rebuild/testing/troubleshooting details. |
| CONTRIBUTING.md | Adds a Windows note pointing to the guide and references it for PowerShell test commands. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
docs/windows-dev-setup.mdwith Windows-specific dev setup (pnpm, VS Build Tools, native rebuild, PowerShell test commands, troubleshooting)Testing
pnpm typecheckpasses on Windowspnpm exec electron ... vitest runworks in PowerShellnode scripts/rebuild-native.mjsrebuilds better-sqlite3pnpm devlaunches the app