component-alpha-rank

component-alpha-rank is a component library designed to simplify the creation of UI components. It is built with TypeScript, Vite, and Storybook, providing tools for rapid development and previewing of components.

Installation

You can install component-alpha-rank using npm:

npm install component-alpha-rank

Or with Yarn:

yarn add component-alpha-rank

Usage

Tailwind CSS Setup

The component-alpha-rank styles need to be added to your project's global styles, and they need to be first in the file, in case they're overridden

@import url(component-alpha-rank/dist/style.css);

If your project uses tailwind css, you'll need to add the following configuration to the tailwind.config.js attachment:

module.exports = {
  content: [
    "./node_modules/component-alpha-rank/dist/*.js",
  ],
};

To use components from component-alpha-rank in your project, import them as follows:

import { MyComponent } from 'component-alpha-rank';

const App = () => (
  <div>
    <MyComponent />
  </div>
);

export default App;

Ensure that you have react and react-dom dependencies in your project.

Scripts

Build

To build the library for production:

npm run build

This command uses TypeScript and Vite to create production builds for the library.

Lint

To run ESLint on your codebase:

npm run lint

Storybook

To run Storybook for component development and preview:

npm run storybook

To build Storybook for production:

npm run build-storybook

Publish

To publish the package:

• For a beta release:

  npm run publish:beta

• For a public release:

  npm run publish

Development

Prerequisites

Ensure you have Node.js and npm or Yarn installed on your machine. You also need React and React DOM version 18.3.1 or higher as peer dependencies.

Setup

To set up the development environment:

1. Clone the repository:

   git clone https://github.com/your-username/component-alpha-rank.git

2. Install dependencies:

   npm install
   # or
   yarn install

3. Run Storybook to start developing components:

   npm run storybook

License

This project is licensed under the ISC License.

Author

Created by [email protected].

Contributing

If you'd like to contribute, please create a pull request or raise an issue.

Contact

For questions or support, please reach out to the author via email.