0.0.3 • Published 1 month ago

@telicent-oss/ds v0.0.3

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
1 month ago

Telicent Design System (DS)

A component library to help developers create frontend applications for Telicent.io platform apps.

This repo contains: 1. ReactJS Components that adhere to the Design System rules1 2. A generated Storybook, describing the components

1 The Design System rules are contained in a Figma file (private for now)

Install

This repository is published as an npm package at @telicent-oss/ds and is installable via:

npm install @telicent-oss/ds

Usage

Before you start, import the required styles into your top-level file:

import "@telicent-oss/ds/dist/style.css";
import "@telicent-oss/ds/dist/fontawesome.css";

Then search for a component in the Storybook. Navigate between stories by clicking on them in the sidebar or using the sidebar searchbox.

Once you have found the component, you can import it into your application:

import { TeliStandardLayout } from '@telicent-oss/ds';

Run storybook locally

git clone https://github.com/Telicent-oss/telicent-ds.git
cd telicent-ds
yarn && yarn storybook