Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 1.26 KB

README.md

File metadata and controls

59 lines (37 loc) · 1.26 KB
Raw

Readme for Social Income's User Interface (UI)

The UI guidelines, specifications, assets and components to be used for Social Income services and platforms.

  • Reusable components for React
  • Documentation, preview and test environment with Storybook.

Usage in projects

To use the React components in a project:

Installation

Add to package.json file in project:

"@socialincome/ui": "^1.0.0",

Usage

Use the components:

import { Typography } from '@socialincome/ui';

Next to the custom components, the UI package also exports the all components from shadcn/ui. See the documentation for more information.

Development

Prerequisites

Setup as described in the README.md of the root folder of this monorepo.

Setup

This package should be run within the public monorepo of Social Income.

# Build the UI. For one time builds e.g. production builds.
ui:build

# Run the development server on http://localhost:6006. Use only this while developing for the UI.
ui:serve

Contribute

There are several ways to contribute to the Social Income UI project. See the CONTRIBUTING.md file.

For more information: Main Readme / UI Contributing