An open API service indexing awesome lists of open source software.

https://github.com/efureev/granularity


https://github.com/efureev/granularity

component design-system vue3

Last synced: 10 days ago
JSON representation

Awesome Lists containing this project

README

          

# granularity

๐ŸŒ **Live showcase:** **https://efureev.github.io/granularity/** ย ยทย 
[![Showcase](https://img.shields.io/badge/showcase-online-brightgreen?logo=githubpages)](https://efureev.github.io/granularity/)
[![npm](https://img.shields.io/npm/v/@feugene/granularity.svg?logo=npm)](https://www.npmjs.com/package/@feugene/granularity)

Monorepo for the [`@feugene/granularity`](./packages/granularity) design system โ€” a Vue 3 package
with components, styles, and a UnoCSS preset that supports granular subpath exports.

## Contents

- `packages/granularity` โ€” the published [`@feugene/granularity`](./packages/granularity/README.md) package.
- `apps/showcase` โ€” live component showcase, deployed to GitHub Pages.
- `apps/playground*` โ€” sandboxes for integration scenarios (not published, not covered by CI).

## Requirements

- Node.js `>= 22`
- Yarn `1.22.x` (Classic, see `packageManager` in the root `package.json`)

## Quick start

```bash
yarn install
yarn build:granularity # build the package
yarn test:granularity # run package tests
yarn dev:showcase # run the showcase locally
```

## Release

- Package versions are published to `npm` and GitHub Packages on `v*` tags via GitHub Actions.
- See [`CONTRIBUTING.md`](./CONTRIBUTING.md) and [`CHANGELOG.md`](./CHANGELOG.md) for details.

## License

[Apache License 2.0](./LICENSE) ยฉ Evgeniy Fureev