https://github.com/selfkeyfoundation/selfkey-ui
Live Storybook
https://github.com/selfkeyfoundation/selfkey-ui
Last synced: about 1 year ago
JSON representation
Live Storybook
- Host: GitHub
- URL: https://github.com/selfkeyfoundation/selfkey-ui
- Owner: SelfKeyFoundation
- Created: 2018-04-26T00:41:53.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-06T21:39:33.000Z (about 3 years ago)
- Last Synced: 2025-04-03T18:11:27.412Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://selfkeyfoundation.github.io/selfkey-ui/
- Size: 14.7 MB
- Stars: 4
- Watchers: 11
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SelfKey UI Library
This module contains common UI components for the SelfKey family of applications written in Typescript.
It uses [Storybook](https://storybook.js.org/) for development, [Yarn](https://yarnpkg.com/en/) for dependency management and [Jest](https://facebook.github.io/jest/) for testing.
Components hot-reload during development and stories are automatically loaded from the `stories` directory from any files with the `.stories.tsx` extension.
## Setup
```bash
yarn
yarn global add @storybook/cli
yarn start
```
Storybook will be available in your browser at http://localhost:6006 after the bundle is built.
## Commitizen
This project uses Commitizen with the Jira Smart Commit adapter. Please install commitizen and use the `git cz` command when creating commit messages.
```bash
npm install -g commitizen
# Make changes to things
git add .
git cz
```
Commitizen ensures that commit messages are formatted correctly and contain the required keywords and tags for our Jira workflow automation to trigger.