mk-design

Description

mk-design is a design library aimed at providing reusable and customizable components to enhance the development process. It serves as a toolkit for building modern, robust, and visually appealing user interfaces.

Features

• Reusable Components: Easily reusable UI components to speed up development.
• Customizable: Fully customizable to fit various design needs.
• Responsive Design: Optimized for different device sizes and resolutions.
• Storybook Support: Integration with Storybook for visual testing and documentation.

Installation

Install the package using npm:

yarn add mk-design

Usage

import { Button } from 'mk-design';

function App() {
  return <Button label="Click Me" />;
}

export default App;

Development

To contribute or run the library locally:

1. Clone the repository:

   git clone https://github.com/your-repo/mk-design.git

2. Install dependencies:

   yarn install

3. Start the development server:

   yarn start

Storybook

Run Storybook to view and test components:

yarn storybook

Scripts

• yarn start: Runs the development environment.
• yarn build: Builds the library for production.
• yarn test: Runs the test suite.
• yarn run storybook: Starts the Storybook environment.

License

This project is licensed under the MIT License.