addons-frontend

Windows

In order to work on addons-frontend on Windows (10), you must:

  1. install the Windows Subsystem for Linux (WSL) version 1
  2. use the Ubuntu 18 LTS distribution

Note 1: it is important to not have Node.js installed on your main Windows system because these tools are available in WSL and can conflict with the tools installed in WSL itself.

Note 2: it might work with WSL 2 or a different distribution but it is not the recommended setup as we cannot test all the different combinations.

Next, open Ubuntu and install Node.js (npm ships with it; this is pretty standard but those commands have been tested when writing this guide):

$ curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
$ sudo apt update
$ sudo apt-get install -y nodejs gcc g++ make

Your (sub-)system is now ready and you can follow the common instructions to get started.

Troubleshooting

Running npm install fails with an EPERM error

This can be caused by Node.js being installed on the main Windows system or a cache issue. Make sure to use the npm CLI installed as described in the previous section. You can also try to clean your npm cache:

$ npm cache clean --force

When such an error occurs, it is also best to remove the node_modules/ folder before re-running npm install.