mirror of
https://github.com/HoshinoSuzumi/rayine-ui.git
synced 2025-04-10 20:18:50 +08:00
73 lines
1.8 KiB
Markdown
73 lines
1.8 KiB
Markdown
# Rayine UI
|
|
|
|
|
|
|
|
[![npm version][npm-version-src]][npm-version-href]
|
|
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
|
[![License][license-src]][license-href]
|
|
|
|
RayineUI is a multi-purpose customizable UI library.
|
|
|
|
- [✨ Release Notes](/CHANGELOG.md)
|
|
- [📖 Documentation](https://rayui.uniiem.com)
|
|
|
|
## Features
|
|
|
|
<!-- Highlight some of the features your module provide here -->
|
|
- ⚙️ Fully customizable components
|
|
- 🌪️ TailwindCSS inside
|
|
- 🔨 Full TypeScript support
|
|
|
|
## Quick Setup
|
|
|
|
Install the module to your Nuxt application with one command:
|
|
|
|
```bash
|
|
npx nuxi module add rayine-ui
|
|
```
|
|
|
|
That's it! You can now use Rayine UI in your Nuxt app ✨
|
|
|
|
|
|
## Contribution
|
|
|
|
<details>
|
|
<summary>Local development</summary>
|
|
|
|
```bash
|
|
# Install dependencies
|
|
npm install
|
|
|
|
# Generate type stubs
|
|
npm run dev:prepare
|
|
|
|
# Develop with the playground
|
|
npm run dev
|
|
|
|
# Build the playground
|
|
npm run dev:build
|
|
|
|
# Run ESLint
|
|
npm run lint
|
|
|
|
# Run Vitest
|
|
npm run test
|
|
npm run test:watch
|
|
|
|
# Release new version
|
|
npm run release
|
|
```
|
|
|
|
</details>
|
|
|
|
|
|
<!-- Badges -->
|
|
[npm-version-src]: https://img.shields.io/npm/v/rayine-ui/latest.svg?style=flat&colorA=020420&colorB=00DC82
|
|
[npm-version-href]: https://npmjs.com/package/rayine-ui
|
|
|
|
[npm-downloads-src]: https://img.shields.io/npm/dm/rayine-ui.svg?style=flat&colorA=020420&colorB=00DC82
|
|
[npm-downloads-href]: https://npm.chart.dev/rayine-ui
|
|
|
|
[license-src]: https://img.shields.io/npm/l/rayine-ui.svg?style=flat&colorA=020420&colorB=00DC82
|
|
[license-href]: https://npmjs.com/package/rayine-ui
|