Skip to content

Commit

Permalink
added instructions for wsl2 installation (#498)
Browse files Browse the repository at this point in the history
* added instructions for wsl2 installation

* updated wsl2 instructions to incorporate comments
  • Loading branch information
dschwindt authored Nov 9, 2021
1 parent d5a0f0c commit d6b1471
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,15 @@ If you wish to run tests locally, you will need to ensure that `redis-server` is

Once Redis is installed, run our entire test suite with `yarn test`.

### Windows 10 Installation on Windows Subsystem for Linux 2

1. First [Install WSL2](https://docs.microsoft.com/en-us/windows/wsl/install) choosing Ubuntu or distribution of choice.
2. [Install NVM](https://simplernerd.com/install-node-npm-wsl2/) to allow for different versions of Node. This will also install NPM.
3. [Install yarn globally](https://classic.yarnpkg.com/en/docs/install)
4. [Install Docker Desktop](https://docs.docker.com/desktop/windows/install/) for Windows with WSL2 support. Note that it's important to do this after installing WSL2.
5. Fork or clone the repository into a folder native to Linux and not the Windows system. This avoids problems with line ending differences between Windows and Linux. It is also much faster to access the Linux filesystem directly rather than the Windows filesystem through Linux.
6. Run `yarn start:local` as noted above.

### Troubleshooting

#### The engine "node" is incompatible with this module.
Expand Down

0 comments on commit d6b1471

Please sign in to comment.