@geekbot/gui

Description

@geekbot/gui is a library that provides a collection of UI components for use in Geekbot applications. These components are designed to be easy to integrate and customize, helping you create visually appealing and consistent user interfaces.

Installation

To add the @geekbot/gui library to your project, you can use either Yarn or npm:

Using Yarn:

yarn add @geekbot/gui

Using npm:

npm install @geekbot/gui

Usage

After installing the package, you need to import the CSS file to apply the necessary styles to the components. Add the following line to your project's main CSS or entry file:

import '@geekbot/gui/dist/geekbot-gui.min.css';

Now you can import the components like:

import { Avatar } from '@geekbot/gui';

Development

Scripts

1. Run the following command to generate the production distribution files on every change while you work:

  yarn watch

2. If you prefer to generate the production distribution files manually after you have made all the changes, run:

  yarn build

Storybook

@geekbot/gui comes with a Storybook, which is a development environment for UI components. It allows you to interactively view and test the components in isolation.

Development mode

To run the Storybook in development mode, use the following command:

  yarn storybook

Generate Static Storybook Files

If you need to generate static files for the Storybook, you can do so by running the following command:

  yarn build-static