The following repository holds the source code for the STORMM [Website].
Similar to STORMM, the code herein is also licensed under MIT, and we welcome all contributions from the Open Source community. Please note that direct contributions and access will not be granted. We encourage you to create your own forks, and submit any changes as Pull Requests using GitHub.
To get started with editing and suggesting changes to the STORMM website, first fork and clone the website on your local machine. Afterwards, we will need to install NVM, Node, and NPM to compile the website from Markdown pages to html.
Before installing NVM, ensure you have the following:
- A terminal application: Such as Bash, Zsh, or similar.
- curl or wget: For downloading the NVM installation script. Most Unix-like systems have these pre-installed. You can check if they are installed by typing
curl --versionorwget --versionin your terminal. If not installed, you can install them using your system's package manager. For example, on Debian/Ubuntu:sudo apt install curlorsudo apt install wget. On Fedora/CentOS/RHEL:sudo dnf install curlorsudo yum install wget. - Git: To clone the repository. Check with
git --version. Install if necessary (e.g.,sudo apt install giton Debian/Ubuntu,sudo dnf install giton Fedora).
Firstly, we need to install Node Version Manager:
-
Install NVM:
-
Open your terminal.
-
Run the following command to download and install NVM:
curl -o- [https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh](https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh) | bash(Note: Check the NVM repository for the latest version and replace
v0.39.1if necessary.) -
Alternatively, you can use
wget:wget -qO- [https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh](https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh) | bash
-
-
Source NVM:
-
After the installation script finishes, you need to source your shell's configuration file to make the
nvmcommand available. The installation script usually adds the necessary lines to your~/.bashrc,~/.zshrc, or~/.profilefile. -
Run the following command, or open a new terminal:
source ~/.bashrc # If you use Bash source ~/.zshrc # If you use Zsh source ~/.profile # If you use a generic profile
-
-
Install Node.js:
-
Use NVM to install a specific version of Node.js. It's generally recommended to use an LTS (Long Term Support) version. To find the latest LTS version, you can check the Node.js website.
-
To install the latest LTS version:
nvm install --lts
-
To install a specific version (e.g., 18.17.1):
nvm install 18.17.1
-
-
Set the Default Node.js Version (Optional):
-
If you have multiple Node.js versions installed, you can set a default:
nvm alias default <version> # Replace <version> with the desired version (e.g., "lts", "18.17.1")
-
-
Verify Installation:
-
Check that NVM is installed correctly:
nvm --version
-
Check that Node.js and npm (Node Package Manager) are installed correctly:
node -v npm -v
-
For Windows, you'll need to use NVM for Windows, which is a different project from the NVM used on Linux/macOS.
-
Install NVM for Windows:
- Go to the NVM for Windows releases page.
- Download the latest
nvm-setup.exeexecutable. - Run the installer. Follow the on-screen instructions. You'll typically accept the license agreement, choose an installation location, and set the Node.js symlink.
-
Open a Command Prompt as Administrator:
- After installation, you'll need to use a Command Prompt or PowerShell with administrator privileges. Right-click on "Command Prompt" or "PowerShell" in the Start Menu and select "Run as administrator".
-
Install Node.js:
-
Use NVM for Windows to install a specific version of Node.js. As with Linux/macOS, it's recommended to use an LTS version.
-
To install the latest LTS version:
nvm install --lts
-
To install a specific version (e.g., 18.17.1):
nvm install 18.17.1
-
-
Use a Node.js Version:
- To use an installed version of Node.js:
nvm use <version>
- To use an installed version of Node.js:
-
Set the Default Node.js Version (Optional):
bash nvm alias default <version> -
Verify Installation:
-
Check that NVM for Windows is installed correctly:
nvm --version
-
Check that Node.js and npm are installed correctly:
node -v npm -v
-