-
Notifications
You must be signed in to change notification settings - Fork 469
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.
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
Prerequisites and better clarification #183
base: master
Are you sure you want to change the base?
Conversation
Steps for the Windows WSL are also added
docs/dev-guide/web.md
Outdated
```bash | ||
npm update | ||
npm install webpack | ||
npm install lib-jitsi-meet |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is incorrect. lib-jitsi-meet is depended upon by jitsi-meet, you don't need to install it globally. What's more, that npm package is very old and not maintained by us.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Allright, I had to install the two packages to make it work and I didn't know that lib-jitsi-meet wasn't use. I removed it from the PR. Any other suggestions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some more comments, please take a look!
|
||
```bash | ||
npm update | ||
npm install webpack |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is also not needed, webpack is a dev dependency and gets installed when running npm install.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe a dedicated section titled "Developing on Windows" would be best.
|
||
## Prerequisites | ||
|
||
The setup for the development environment uses `make`, a native command from GNU/Linux. **This guide assumes that you have a Linux system with Ubuntu or Debian, or Windows Subsystem for Linux (WSL)[https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux]**. If you have iOS or other Linux distro, the process should of the installation of packages will be diferent depending on your OS. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add a ::: note
for windows users instead? The proposed wording sounds confusing since it doesn't mention macOS for example.
git clone https://github.com/jitsi/jitsi-meet | ||
cd ./jitsi-meet/ | ||
|
||
npm update && npm install |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't run npm update, it will most likely break things.
Hey @JulianGR do you still intend to finish this one? |
I'm participating in the Hackathon and I had a difficult time setting up the environment because some steps were missing. That's the reason I added the missing step such as in the Prerequisites
I've also added the steps that I had to make it run in a Windows WSL, such as the section with the ports and ufw.