Skip to content

Install Guide

Jump to bottom
Frank Matranga edited this page Feb 5, 2022 · 7 revisions

Install WSL

It is highly recommended that you install the Windows Subsystem for Linux and use Ubuntu, instead of trying to install all of the developer tools on Windows directly. Simply run the following command either in Windows Command Prompt or an administrator PowerShell and then restarting:

wsl --install

See here for more details and troubleshooting.

You now have Ubuntu installed through WSL! All of the references to commands in the rest of this document are to be run in the WSL command prompt. You can access this via the Search Menu by searching for either wsl or Ubuntu.

Setup Git on WSL

You might already have Git installed and configured on Windows, but you'll need to do so on WSL since you'll be working through there.

Install Git via apt:

sudo apt-get install git

Configure your name:

git config --global user.name "Your First and Last Name"

Configure your email and be sure to use the same email you use for GitHub:

git config --global user.email "youremail@domain.com"

You can now use git commands from the WSL terminal!

Install NVM and Node

The developer tooling we use uses Node for pretty much everything! The recommended way to install it is via Node Version Manager (nvm).

Install the curl utility in your WSL terminal:

sudo apt-get install curl

Install the latest version of nvm:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

Finally, install the latest long term support version of Node via nvm:

nvm install --lts

See here for more details and troubleshooting.

You now have access to Node on WSL! You can test this by opening a Node REPL with the node command.

Install Visual Studio Code with Extensions

It is highly recommended that you use Microsoft's Visual Studio Code editor (not Visual Studio IDE) as it is really well integrated with both WSL and TypeScript since these are all Microsoft-made.

Install Visual Studio Code for Windows directly here.

Once installed, you should install two official extension packs, one for WSL and one for NodeJS.

  1. Install the WSL Extension.

  2. Open a new WSL window in VSCode via the bottom left

  3. Then, install the NodeJS Extension Pack in WSL and not locally.

View a screen recording of steps 2 and 3

Setup the Wrathspriter Repository

Navigate to a good folder in the WSL filesystem to clone the repository into:

mkdir ~/git && cd ~/git

Clone the Apexal/wrathspriter repository there:

git clone https://github.com/Apexal/wrathspriter.git

Navigate to the repository folder:

cd wrathspriter

Install all of the dependencies:

npm install

Start the development server:

npm start

If everything works, a tab to localhost:3000 will be opened in your default browser and you should see the webapp!

Clone this wiki locally