This repository contains the source code for the June UI library.
To see the components in action, visit the Storybook.
This library is an experiment to be a middle ground between Application UI templates like Tailwind UI, and design systems built for specific companies like Shopify Polaris.
The goal is to provide a set of high-quality beautiful components and charts, that can be easily integrated into any project without the need for customization.
The components are not meant to be as composable as Radix UI - they are meant to be good enough to be used as is, but customizable enough to fit the needs of most small apps.
Our approach is to extract generic components from June and make them:
- Easily reusable
- Beautiful and polished - to be used as is
- Flexible enough - to be customized when needed
To install the library, run the following command:
npm install @june-so/uiTo use the library, import the components you need and use them in your project:
import "@june-so/ui/style.css";
import { BarChart } from '@june-so/ui';That's it for now! This library is still in alpha development, so don't expect too much from it just yet.
To start developing the library, clone the repository and install the dependencies:
git clone https://github.com/junehq/ui.git
cd ui
npm installTo start the development server and Storybook, run the following commands:
npm run storybook
npm run dev This will start the Storybook server and the development server for the library.
To run the tests, use the following command:
npm run testTo release a new version of the library, run the following command:
npm version patchThis will update the version number in the package.json file and create a new tag in the Git repository.
After that, you can publish the new version to NPM by merging your changes to the main branch.
We welcome contributions to the library! If you have an idea for a new component, a bug fix, or a feature request, please open an issue or a pull request.