Skip to content
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

Added Documentation for Windows WSL2 Client Setup #5169

Merged
merged 2 commits into from
Jun 17, 2021
Merged

Added Documentation for Windows WSL2 Client Setup #5169

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8da3d2
Added Documentation for Windows WSL2 Client Setup
rahulramesha Jun 16, 2021
a00368d
Changing instruction for better setup
rahulramesha Jun 16, 2021
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
18 changes: 18 additions & 0 deletions contributions/ClientSetup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,24 @@ node versions to be used in different projects. Check below for installation and
yarn start
```

### Windows WSL2 Setup

Before you follow the instructions above, make sure to check the following steps:

1. You have **WSL2** setup in your machine. If not, please visit: [https://docs.microsoft.com/en-us/windows/wsl/install-win10](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
2. You have **Docker Desktop** installed with WSL2 backend. If not, please visit: [https://docs.docker.com/docker-for-windows/wsl/](https://docs.docker.com/docker-for-windows/wsl/)

In the above Docker Desktop setup instructions, make sure to:
1. Set WSL Distro to run in WSL2 mode.
2. Enable integration with the WSL Distro in Docker Desktop.
3. Install [Remote-WSL](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) extension in VSCode.

And finally, you can open the folder in VSCode with WSL by,
1. Clicking on Green button on the Bottom Left corner in VSCode
2. Selecting **Reopen Folder in WSL**

After this You can continue Setting up from [here](#pre-requisites). But make sure to have `Nodejs` and `npm` installed on the WSL Distro.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we say nodejs and npm is required, Can we point them to possible documentation that shows how to check this and then install if missing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved that up and added a Documentation link.


### Troubleshooting

#### I am on WSL and can't reach dev.appsmith.com
Expand Down