Elentra JS Documentation
2.0
2.0
  • Introduction
  • Why Elentra JS 2.0?
    • Dedicated Repository
    • TypeScript
    • Class-Based Components
    • Vue Standard Routing
    • Organizational Theming
    • Yarn Package Manager
  • Developers
    • Getting Started
    • Setup Guide
      • Install Requirements
      • Clone the Repository
      • Environment Variables
      • Install Dependencies
      • Serve Dev Mode
  • Design System
    • Overview
    • Component Library
      • Directory Structure
      • Components
    • Style Library
      • Directory Structure
      • How it Works
        • Variables
        • Mixins
        • Utility Classes
        • Elements
        • Legacy Styles
        • Shim
    • Taxonomy
      • UI Taxonomy
      • UX Taxonomy
      • Variable & Utility Class Naming Convention
Powered by GitBook
On this page
  • 1. Install NVM on your host machine
  • 2. Install Yarn
  • 3. Install Node via NVM
  • 4. Confirm successful Install of Requirements
  1. Developers
  2. Setup Guide

Install Requirements

PreviousSetup GuideNextClone the Repository

Last updated 4 years ago

In order to start using Yarn you will need to install Node.js, which can be installed with Node Version Manager. Referring to the GitHub page for Node Version Manager is the best way to ensure you have an up-to-date version of Node.js installed.

The following instructions are meant to be run from your host machine, not from within the docker container. This applies to all steps in this setup guide.

1. Install NVM on your host machine

NVM (Node Version Manager) is a tool that allows you to download and install Node.js. Visit this link for install instructions:

Example: Check if NVM is already installed

nvm --version

Example: Install NVM via cURL

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

Example: Install NVM via Homebrew (MacOS - Requires )

brew install nvm

2. Install Yarn

Yarn is a package manager that can be installed following the instructions on their website:

Example: Install Yarn via Homebrew (MacOS - Requires )

brew install yarn

Example: Install Yarn via cURL

curl -o- -L https://yarnpkg.com/install.sh | bash

3. Install Node via NVM

nvm install 14.16
nvm use 14.16

4. Confirm successful Install of Requirements

If all steps above have been done correctly, you should be able to run these commands. Each of these commands should display the version installed.

nvm --version
node -v 
yarn -v
Node Version Manager Installation - GitHub
Homebrew
Official Yarn Documentation: Installation
Homebrew