buildgrid-ui v1.11.5

buildgrid-ui

This lib is under construction, take a look again soon 🚧

A React component library built using Vite and shadcn as the foundation. This library is designed to integrate seamlessly with React and Next.js applications and includes support for TailwindCSS. It also provides a Storybook setup to display and document the components.

Features

• Built with Vite for a fast development experience.
• TailwindCSS Integration for utility-first styling.
• shadcn Components as a robust base.
• Storybook for component documentation and testing.
• Semantic Versioning with automated releases using semantic-release.

Getting Started

Installation

To install the library, run:

npm install buildgrid-ui

or

yarn add buildgrid-ui

Usage

1. Import a component in your React project:

   import { Button } from "buildgrid-ui";
   
   const App = () => <Button variant="primary">Click Me</Button>;
   
   export default App;

2. Ensure TailwindCSS is configured in your project. Add the following imports to your styles.css file (or equivalent):

   @tailwind base;
   @tailwind components;
   @tailwind utilities;

3. Include the tailwind.config.js content paths for buildgrid-ui:

   module.exports = {
     content: [
       "./src/**/*.{js,ts,jsx,tsx}",
       "./node_modules/buildgrid-ui/**/*.{js,ts,jsx,tsx}",
     ],
     theme: {
       extend: {},
     },
     plugins: [],
   };

Development

Setting Up the Project

Clone the repository and install dependencies:

git clone https://github.com/yourusername/buildgrid-ui.git
cd buildgrid-ui
npm install

Storybook

Run Storybook locally to preview and develop components:

npm run storybook

Build the Library

To build the library for production:

npm run build

The output will be in the dist/ directory, ready for publishing or integration.

Semantic Releases

This project uses semantic-release for automated versioning and releases.

Steps to Create a Pre-release

1. Push changes to the designated pre-release branch (e.g., alpha):

   git checkout -b alpha
   git push origin alpha

2. Pre-release versions (e.g., 1.0.0-alpha.1) will be automatically created.

Contributing

Contributions are welcome! To contribute:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Submit a pull request with a detailed description of your changes.

License

This project is licensed under the MIT License.