1.1.1 • Published 9 months ago

hztl-design v1.1.1

Weekly downloads
-
License
MIT
Repository
-
Last release
9 months ago

hztl-design

A React-based design system package with Storybook integration, built using Rollup and Tailwind CSS.

Table of Contents

Installation

Install the necessary dependencies by running:

npm install

Features

  • React 18: The latest version of React for building components.
  • Storybook 8: Interactive environment for UI component development and testing.
  • Tailwind CSS: Utility-first CSS framework for styling.
  • Rollup: Bundler for optimized production builds.
  • TypeScript: Type definitions for better developer experience.

Getting Started

After installation, you can start the development server and view Storybook components using:

npm start

This will start Storybook on port 6006. You can visit it in the browser at http://localhost:6006.

Scripts

  • npm start: Starts the Storybook development server.
  • npm run build: Builds the project using Rollup and TypeScript, along with Tailwind CSS minification.
  • npm run build-storybook: Builds a static version of the Storybook for deployment.
  • npm run build-tailwind: Generates and minifies Tailwind CSS output.

Build Setup

The build pipeline uses Rollup for bundling and Tailwind CSS for styling. TypeScript is also integrated for type-checking.

Rollup

We use rollup.config.js for bundling:

  • CommonJS and Node Resolve plugins are used to handle module imports.
  • Terser is applied for minification in production builds.

Tailwind CSS

Tailwind is configured with a source file located at src/style/tailwind.css and the output is minified and saved in dist/styles.css:

npx tailwindcss -i ./src/style/tailwind.css -o ./dist/styles.css --minify

Contributing

Contributions are welcome! Please create an issue or submit a pull request for any improvements or bug fixes.

License

This project is licensed under the ISC License. See the LICENSE file for more details.

1.1.1

9 months ago

1.1.0

9 months ago

1.0.9

9 months ago

1.0.8

9 months ago

1.0.7

9 months ago

1.0.6

9 months ago

1.0.5

9 months ago

1.0.4

9 months ago

1.0.3-test

9 months ago

1.0.3

9 months ago

1.0.2

9 months ago

1.0.1

10 months ago

0.0.1-hztl

10 months ago

0.0.0-hztl

10 months ago

1.0.0

10 months ago