Skip to content

Commit

Permalink
Merge pull request #5169 from appsmithorg/DOC-client-setup-on-wsl2
Browse files Browse the repository at this point in the history
Added Documentation for Windows WSL2 Client Setup
  • Loading branch information
rahulramesha authored Jun 17, 2021
2 parents 26cd46e + a00368d commit 4f140d4
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions contributions/ClientSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,28 @@ 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 [Node.js](https://www.geeksforgeeks.org/installation-of-node-js-on-linux/) installed on the WSL Distro.
3. 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](https://docs.docker.com/docker-for-windows/wsl/) 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.
Make sure to Clone the Repo in the WSL file system instead of the Windows file System.
And finally, you can open the folder in VSCode with WSL by following the instructions in [Docker Desktop Setup](https://docs.docker.com/docker-for-windows/wsl/),
or Alternatively by,
1. Clicking on the Green button on the Bottom Left corner in VSCode.
2. Selecting **Open Folder in WSL** and navigating to the folder in WSL.
After this You can continue Setting up from [here](#pre-requisites).
### Troubleshooting
#### I am on WSL and can't reach dev.appsmith.com
Expand Down

0 comments on commit 4f140d4

Please sign in to comment.