About

The Urkel component library, a collection of components designed for efficient website customization and standardization.

Folder structure

ucl
  └── .storybook - storybook-specific configuration files
  └── src - All components
  └── addons - Storybook addons
  └── charts - A collection of charts (most with their own library)
  └── contexts - Custom React Contexts
  └── core - Configuration required for entire applications
  └── display - Components that display text or data differently
  └── forms - Components used within forms
  └── icons - All sharable icons
  └── indicators - Components that bring something to the attention of the user
  └── inputs
  └── layout - Components that control placement on a page
  └── navigation - Navigation-only components
  └── shared - Helper functions and utilites that can be exported to other apps
  └── theme - Theme-specific components and helpers
  └── typography - Text-based components
  └── rollup.config.js - the configuration required for simple bundling of the library

Available Scripts

• yarn build:storybook - Builds the storybook integration from UCL development.
• yarn start - Alias for build:storybook
• yarn ucllink - Locally links the yalc version of ucl here. (NOTE: this could be bypassed with yarn workspaces)
• yarn push - Pushes UCL to a local yalc package registry for use during local development