My awesome Library

Dead simple React react component library to build faster and more accessible React applications.

🚀 Features

• Current Project branch: master
• Build Tool: Vite (https://vite.dev/)
• Both CommonJS and ESM modules are supported.
• Tested with Vite, Astro, Remix SSR React App, NextJs, CRA.
• Uses PostCSS with CSS Modules (https://postcss.org/).

Note

Version 2.x.x is a major change and may be directly incompatible with your current project configuration.

Prerequisites

• Npm (Yarn preferably)
• Node >= 20.9.0
• MacOS / Linux / Windows

Usage

yarn install kompoze

Developing for kompoze

git clone git@github.com:iamdipankarj/kompoze.git
cd kompoze
yarn install

• To start your storybook server

yarn start:storybook

• To build your project for external use

yarn build

Writing Components

• Make sure you have hygen installed. https://www.hygen.io/docs/quick-start
• Let's say we want to create a LocationList component:

hygen component new LocationList

• The above command will generate the following files

src/components/LocationList/index.ts
src/components/LocationList/LocationList.tsx
src/components/LocationList/LocationList.types.ts
src/components/LocationList/LocationList.styles.ts
src/components/LocationList/LocationList.stories.tsx

and will inject the references here:

src/components/index.ts

Usage

import { Button, Switch, Alert } from 'kompoze'

Contributing

See CONTRIBUTING.md for more details.