@livesession/genui

@livesession/genui

LiveSession Genui is a UI component library built with React and Vite, designed specifically for creating AI app's UI.

Table of Contents

• @livesession/genui
  • Table of Contents
  • Installation
  • Usage
  • Scripts
  • Configuration
    • Vite Configuration
    • Storybook Configuration
  • Contributing

Installation

To install the project, run:

npm install @livesession/genui

Usage

To use the components in your project, import them as follows:

import { ComponentName } from '@livesession/genui';

Example:

import { SideView } from '@livesession/genui';

function App() {
return
    <SideView tabName="My tab" .../>
}

Scripts

• build: Build the project using Vite.
• watch: Build the project in watch mode.
• storybook: Start the Storybook server.
• build-storybook: Build the Storybook static site.

To run a script, use:

npm run
<script-name>

Example:

npm run build

Configuration

Vite Configuration

The Vite configuration is located in vite.config.ts. You can customize it as needed.

Storybook Configuration

The Storybook configuration is located in .storybook/main.js. You can customize it as needed.

Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -m 'Add new feature').
5. Push to the branch (git push origin feature-branch).
6. Open a pull request.