README
Airbit Design System
To start contributing to this project you will first need to have installed Git and Node.js
Clone the repository locally
Notes:
SSH Authentication
git clone
git clone git@github.com:AirbitUK/ui-core.git
cd ui-core # Enter the cloned directory
Install dependencies
Note:
npm
it comes installed with Node.js
npm install
Run Storybook
Notes:
Learn more in Storybook tutorials.
npm run storybook
Styling
For styling the components, SCSS is used in combination with custom Tailwind CSS config and Vue Scoped CSS
Tailwind
classes are prefixed with ui
, e.g. ui-text-500
Build
For building the library, Vue CLI is used
npm run build