LYRA UI KIT

Quick Start

Repository for the components of Solar Design Tool. It is used to develop and design UI components outside Solar Design Tool in an isolated environment

Getting Started

Prerequisites

• Git
• Node ~v8
• npm ~v6

Installing

After cloning this repository, just go to the folder project and download the dependencies

## Placed on the cloned folder
$ cd lyra-ui-kit

## install project dependencies
$ npm i

After that you can run the server

## Running development server
$ npm run storybook

Now, it should open a new tab in your default browser in the http://localhost:9009. And that's it, now you have the application running and ready to work.

Command Line Usage

The project already has a suit of basic commands with many utilities. You can see the full command list inside the package.json.

• Transpile typescript files

$ npm run build

• Fixes code styling errors running format

$ npm run format

• Removes generated assets after the build command

$ npm run clean

• Running the dev server

$ npm run storybook

• Generating index files and updating exports

$ npm run update-exports

• Create component using template

$ npm run create-component %COMPONENT_NAME%

Built With

• React - Web components
• Styled Components - CSS styling
• Storybook - Tool for developing UI components in isolation
• Webpack - Module bundler