@getscale/getscale-ui v0.2.25

GetScale Storybook Component Library

A modern React component library built with Vite, Storybook, and Tailwind CSS. This library provides a collection of reusable UI components with comprehensive documentation and interactive examples.

Features

• 🎨 Modern UI components built with React
• 📚 Interactive documentation with Storybook
• 🎯 TypeScript support
• 🎨 Tailwind CSS for styling
• 📦 Easy to install and use
• 🔧 Customizable theming
• 📱 Responsive design
• ♿ Accessibility focused

Installation

1. Create a .npmrc file in your project root:

@getsales-inc:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_AUTH_TOKEN

2. Install the package:

npm install @yazan-getscale/getscale-storybook

3. Import the styles in your main application file:

import '@yazan-getscale/getscale-storybook/dist/styles.css';

Project Structure

src/
├── components/     # React components
├── stories/       # Storybook stories and documentation
├── theme/         # Theme configuration
├── utils/         # Utility functions
├── assets/        # Static assets
└── styles.css     # Global styles

Development

1. Clone the repository
2. Install dependencies:

npm install

3. Start Storybook:

npm run storybook

4. Build the library:

npm run build

Available Scripts

• npm run dev - Start development server
• npm run build - Build the library
• npm run storybook - Start Storybook
• npm run build-storybook - Build Storybook
• npm run lint - Run ESLint
• npm run preview - Preview the build

Dependencies

Core Dependencies

• React (>=17.0.0)
• React DOM (>=17.0.0)
• Tailwind CSS
• TypeScript

Development Dependencies

• Vite
• Storybook
• ESLint
• PostCSS
• Various Storybook addons

Publishing

To publish a new version:

1. Update the version in package.json
2. Run the build:

npm run build

3. Publish to npm:

npm publish

4. In your project, update the package:

npm update @yazan-getscale/getscale-storybook

Contributing

1. Create a new branch for your feature
2. Make your changes
3. Write or update stories for your components
4. Submit a pull request

License

MIT License - see LICENSE file for details