Platform 6 UI Components

🚧 This project is currently in development. 🚧

Installation

Use the following command in your terminal to install the project:

git clone https://github.com/amalto/platform6-ui-components.git

You need to install Node.js.

npm install --save @amalto/{component_name}

You must replace {component_name} with the wanted component.

# example
npm install --save @amalto/spinner

You can access the online documentation here.

If you want to access it from your localhost, follow the steps below.

In order to read the documentation you need to install Node.js and the project dependencies.

npm run bootstrap

Then run it locally:

npm run styleguide

You can also build the documentation which will be stored in the styleguide directory:

npm run styleguide:build

You will be able to see the documentation at the url http://localhost:6060

You can chose the version you want to assign to each component by using:

lerna version --no-private