Skip to main content

Installation

This Guide shows you how to setup docusaurus on your local machine to run this docs in your local development enviroment.

Requirements​

  • git
  • Node.js v16

Installation Guide​

Step 1 – Installing Node.js via nvm​

It is recommended to install Node.js via nvm – a node version manager – to have the possibility to switch between different node.js versions.

You must have macOS desktop access with administrator privileges.

Login to the macOS desktop system and install Homebrew on your system (if not already installed).

Install nvm via homebrew:

brew install nvm

Once installed you can check the available versions with

nvm list

If you have no other projects, where you need a different version, it is recommended to install the latest stable LTS version of node.

nvm install lts

nvm has now installed the latest node.js version with its package manager npm. Check if the installation has been successfull by checking it:

node --version

Step 2 – Cloning the repository​

Clone the docs repository via your favourite method:

HTTPS
git clone https://github.com/SovereignCloudStack/docs.git

Step 3 – Installing dependencies​

Change your working directory within your terminal to the root of the cloned repository /docs and install all dependencies:

npm install

Step 4 – Starting the development server​

You can now run the local development server from your terminal:

npm start

Once the server is up and running, your terminal will show you the local URL which you can open with your browser to see the page.