Setting up the Environment
In order to develop for this project, you'll need to get set up for web development. This first part will go over how to get set up with node and npm. This project makes use of npm we do not use yarn.
Installing Node / NPM#
You'll want to be sure to have Node 14.x.x and NPM 6.x.x
Using NVM (recommended)#
- Windows
- Mac
- Linux
Visit NVM for Windows page
Scroll down to Installation & Upgrades and go through the instructions outlined on this page.
note
You Will NEED to uninstall any existing node / npm installations, the Github Repo outlines how to do this
Open the project in your editor of choice and / or open the directory in PowerShell / CMD and run the following
note
nvm use without a version does NOT work for the windows version like it does for Mac / Linux
It is recommended, but not required that you uninstall any existing node / npm installations
Visit the NVM Github page
Scroll down to Installing and Updating and follow the instructions
Open the project in your editor of choice and / or open the directory in the terminal and run the following:
You can also do:
It is recommended, but not required that you uninstall any existing node / npm installations
Visit the NVM Github page
Scroll down to Installing and Updating and follow the instructions
Open the project in your editor of choice and / or open the directory in the terminal and run the following:
You can also do:
Using the installer#
Visit the Node JS Website and download the LTS Release. At the time of writing this, it is 14.17.1.
Run the installer that it downloads and go through the setup. After setup finishes open your terminal and type:
if the install was successful, each command will output a response with a version number.
caution
On unix based operating systems, you may run into permission issues when trying to globally install packages. To fix this, follow this guide which explains how to change the npm global location.
Getting GLOBAL packages#
You may find that you need to install the typescript package globally, in fact it is generally recommended.
To check if the installations worked, you can run:
Typescript is the codebase of the website, and the installation includes a compiler. In case your IDE can not be configured to use the one in node_modules/typescript/lib you will need an installation to fall back on.
And that is all you'll need to get set up, the project itself contains the rest of the npm modules needed to run.
More info coming soon...