Skip to content

Add note for dev mode on windows #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jspahrsummers merged 11 commits into from
Feb 19, 2025
Merged

Add note for dev mode on windows #148

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
348cff9
Add note on dev mode for Windows users
olaservo Feb 14, 2025
2a1536d
Revert other changes
olaservo Feb 14, 2025
b8e7388
Revert other changes
olaservo Feb 14, 2025
7c57e82
Fix style issues
olaservo Feb 14, 2025
39970db
Merge branch 'main' into add-note-for-dev-mode-on-windows
olaservo Feb 19, 2025
7b40aed
Add dev:windows command
olaservo Feb 19, 2025
02f5300
Merge branch 'main' into add-note-for-dev-mode-on-windows
olaservo Feb 19, 2025
e22d3c7
Revert unintentional package-lock change
olaservo Feb 19, 2025
8e06165
Revert unintentional package-lock change
olaservo Feb 19, 2025
ed59974
Add dev:windows to server instead and reference from root package.json
olaservo Feb 19, 2025
266e8be
Fix formatting
olaservo Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,15 @@ Development mode:
npm run dev
```

> **Note for Windows users:**
> On Windows, you may experience an issue where the proxy server fails to start when running the `npm run dev` command. This is due to TSX's watch mode not properly handling standard input on Windows.
>
> To work around this, you can append `< NUL` to the `dev` script in `/server/package.json`:
>
> ```bash
> tsx watch --clear-screen=false src/index.ts < NUL
> ```

Production mode:

```bash
Expand Down
18 changes: 7 additions & 11 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion server/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"scripts": {
"build": "tsc",
"start": "node build/index.js",
"dev": "node --import tsx --watch --watch-preserve-output src/index.ts"
"dev": "tsx watch --clear-screen=false src/index.ts"
},
"devDependencies": {
"@types/cors": "^2.8.17",
Expand Down