https://github.com/sliit-foss/bashaway-ui
React component library for Bashaway 2023
https://github.com/sliit-foss/bashaway-ui
bashaway component-library storybook
Last synced: 4 months ago
JSON representation
React component library for Bashaway 2023
- Host: GitHub
- URL: https://github.com/sliit-foss/bashaway-ui
- Owner: sliit-foss
- License: mit
- Created: 2023-08-24T20:58:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-13T07:21:23.000Z (over 1 year ago)
- Last Synced: 2025-08-14T00:04:44.949Z (4 months ago)
- Topics: bashaway, component-library, storybook
- Language: JavaScript
- Homepage: http://design.bashaway.sliitfoss.org/
- Size: 57.2 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
The official design system for Bashaway 2023
## Using components
Run `pnpm i @sliit-foss/bashaway-ui` to incorporate into your project
Example
```js
import { Button, Bashaway, Title } from "@sliit-foss/bashaway-ui"
---or---
import { Button } from "@sliit-foss/bashaway-ui/components"
import { Title } from "@sliit-foss/bashaway-ui/typography"
import { Bashaway } from "@sliit-foss/bashaway-ui/icons"
....
<>
Hello there
Click Me!
>
...
```
## Getting started
- Run `pnpm install` to install all dependencies
- Run `pnpm storybook` to start the storybooks dev server
- Run `pnpm build-storybook` to build the project for a web release
- Run `pnpm build` to build the project for a package release
## Commit messages
- We follow conventional commits during our development workflow as a good practice. More information can be found at their official [documentation](https://www.conventionalcommits.org/en/v1.0.0-beta.4/#examples)
- Refer the [commitlint.config.js](https://github.com/sliit-foss/bashaway-ui/blob/main/commitlint.config.cjs) file for a full list of supported commit message prefixes
## Additional tools
- This project is bootstrapped with [Lefthook](https://evilmartians.com/opensource/lefthook), [Eslint](https://eslint.org/) and [Prettier](https://prettier.io/). Please make good use of them.