Skip to main content

Development

Installation

Guide for installing Legion to your development

banner-Installation

Prequisites

Already have at least these below:

  • Nodejs v16 or above, if you are using multiple versions of node, we recommend using nvm to manage its version
  • Node Package Manager v8 or above
  • Yarn v1.22.19 or above

Installation

Proxy and Authentication

To be able to use Legion, you must be authenticated first through the .npmrc to access the private registry of the package.

But in order to be authenticated you have to gain the access from the Legion UI Support, by filling the following This link request, if your request is granted you will be given an authentication token and registry to pull the package from immediately.

After you gained it, follow steps below:

  1. Add .npmrc file to your project, make sure to not push it to your repo or add it to your .gitignore:

  2. Fill the .npmrc file with following lines:

registry=??
_auth=??
always-auth=true

Replace the ?? placeholder with the gained credentials you get from the email.

  1. Now you should be ready to go to use Legion!

Install or Add Dependency

To install and save it in your package.json dependencies, please run following command using npm:

npm install legion-ui

Or if you use yarn, don’t worry we got your needs covered too!

yarn add legion-ui

Adding the themes

With our intention to simplify, make both designer and developer product development seamless, some tribes have their team already provided, following are the currently available tribes for installation.

Tribe NameNpm CommandYarn Command
Agreenpm install @legion-theme/agreeyarn add @legion-theme/agree
Logeenpm install @legion-theme/logeeyarn add @legion-theme/logee
EDUnpm install @legion-theme/eduyarn add @legion-theme/edu
ENTnpm install @legion-theme/entyarn add @legion-theme/ent
EWZnpm install @legion-theme/ewzyarn add @legion-theme/ewz
FINnpm install @legion-theme/finyarn add @legion-theme/fin
SMBnpm install @legion-theme/smbyarn add @legion-theme/smb
VPLnpm install @legion-theme/vplyarn add @legion-theme/vpl

And with that, you’re set and ready to configure it in our next article!