Skip to content

Fix/readme setup instructions#369

Open
Shashwat325 wants to merge 3 commits intoaces:masterfrom
Shashwat325:fix/readme-setup-instructions
Open

Fix/readme setup instructions#369
Shashwat325 wants to merge 3 commits intoaces:masterfrom
Shashwat325:fix/readme-setup-instructions

Conversation

@Shashwat325
Copy link

While trying to start the brainbrowser on my pc I faced certain issues and realized that due to the brainbrowser old packages they conflict with modern npm and thus the current README instructions are not enough for new users to run this project as there are some commands that we need to use in order to run this project the brief description about the problems is:

Problems Found

Missing npm install --legacy-peer-deps old packages conflict with modern npm's strict dependency rules causing an ERESOLVE error
Missing npm install -g grunt-cli without this grunt command is not found
Missing grunt compile without this both viewers show a black screen with 404 errors in the browser console grunt build fails on modern Node.js due to broken test suite
No documentation for Windows users Unix symlink silently breaks on Windows causing 404 errors with no explanation.

Changes Made

Added all missing setup commands
Added Windows/WSL section with symlink fix
FIxed some typos in README

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant