README.md

Bamboo

Lightweight and flexible (hence the name) UI Library built with Vite and Vue 3. The documentation is created with Storybook.

Add to your project

To install the library, run the following command:

npm install @mrksbnc/bamboo

After this you need to import the css file in your main.js or main.ts file.

import '@mrksbnc/bamboo/lib.css'

After this you can use the components in your components.

<script setup lang="ts">
import { BoButton } from '@mrksbnc/bamboo'
</script>

<template>
  <bo-button label="Button" />
</template>

Project setup

You need to have node and npm installed on your machine as a prerequisite. You can download and install them from here.

Install dependencies

To install the dependencies, run the following command:

npm install

Run documentation

To start the development server, run the following command:

npm run storybook

This will start the Storybook server and open the browser at http://localhost:6006. Here you can see the documentation for the components and play around with them.

Build for production

To build the components for production, run the following command:

npm run build

This will build the components and generate the static files in the dist folder.

Build storybook for production

To build the Storybook documentation for production, run the following command:

npm run build:storybook

This will build the Storybook documentation and generate the static files in the static folder. GitHub Pages uses the directory to host the documentation.

Run your unit tests

The project uses Vitest for unit and snapshot testing. To run the tests, run the following command:

npm run test

Lints and fixes files

The project uses ESLint and Prettier for linting and formatting. To run the linter, run the following command:

npm run lint

License

MIT