README.md

The official design system for Bashaway 2023

Using components

Run pnpm i @sliit-foss/bashaway-ui to incorporate into your project

Example

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"

....
  <>
    <Bashaway/>
    <Title>Hello there</Title>
    <Button>Click Me!</Button/>
  </>
...

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
• Refer the commitlint.config.js file for a full list of supported commit message prefixes

Additional tools

• This project is bootstrapped with Lefthook, Eslint and Prettier. Please make good use of them.