Improve Windows setup and troubleshooting documentation #5
Description
Description:
Currently, the README and setup instructions focus on general installation but lack clear guidance for Windows contributors. This can cause confusion during onboarding, especially around environment setup and dependency resolution.
Suggested Improvements
- Add step-by-step instructions for Windows users:
- Installing Node.js and npm with correct versions.
- Handling --legacy-peer-deps during installation.
- Common fixes for Webpack/port conflicts (e.g., 8080).
Include troubleshooting tips for:
- npm run start errors (missing dependencies, port already in use).
- Build failures when running npm run build.
- Provide screenshots or diagrams for clarity.
- Add a dedicated Windows Setup Guide section in the README.
Benefits
- Makes the project more inclusive for Windows contributors.
- Reduces repetitive support questions.
- Streamlines onboarding for new developers.