@ifings/design-system

iFings Design System

Usage no npm install needed!

<script type="module">
  import ifingsDesignSystem from 'https://cdn.skypack.dev/@ifings/design-system';
</script>

README

@ifings/design-system

Commitizen friendly

iFings Design System

Install

Please ensure that all Peer dependencies have been installed in the project.

npm install @ifings/design-system

Usage

import {DashboardLayout} from "@ifings/design-system"

This repo is currently being consumed by fng-web-portal and fng-web-hardware.

Development

We use Storybook for Component driven development:

$ npm start

Environment

At the root of your project add a .env file with

STORYBOOK_DATA_GOOGLE_MAPS_API_KEY=AIzaSyCfjsVA5s9NfxpTsRZsOwWZHzKhbrE1GcY

Goals

  • Create consistency across products.
  • Increase design and development velocity.
  • Improve overall quality of the codebase.
  • Provide a base set of components that can be reused in many contexts.

Contributing

Contributions are welcome. Please open up an issue or create PR if you would like to help out.

For all contributors, please be sure to read the Contributing doc.

License

MIT