Platform 6 UI Components

:construction: This project is currently in development. :construction:

Installation

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

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

With npm

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

Documentation

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

License

MIT © 2018 Amalto Technologies