get-convex / get-convex/convex-tutorial

Issue in the React Tutorial on Windows

Open Beginner friendly
#11 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
CSS
Stars
31
Forks
62
PR merge metrics
No merged PRs in 30d

Description

Hi! I was following the React tutorial (https://docs.convex.dev/tutorial/overview) on Windows and ran into an issue. When adding the dev script to package.json exactly as documented: "dev": "convex dev --start 'vite --open'"

Running npm run dev fails on Windows with the error: error: unknown option '--open''.

The Fix: It works perfectly on Windows if the single quotes are replaced with escaped double quotes instead: "dev": "convex dev --start \"vite --open\""

It might be helpful to update the docs/templates so Windows users don't get stuck here!

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the React tutorial at docs.convex.dev/tutorial/overview and inspect the package.json dev script shown there, then run npm run dev on Windows to reproduce the quoting error. Update the relevant docs or templates so the Windows command works, and verify that the documented command no longer produces the unknown option error.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, vite
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.