https://github.com/samk-dev/astratto-ui
Yes, yet another UI library, built on top of UIkit 3 && it's exclusive to Nuxt.
https://github.com/samk-dev/astratto-ui
nuxt-module nuxtjs ui-library uikit
Last synced: over 1 year ago
JSON representation
Yes, yet another UI library, built on top of UIkit 3 && it's exclusive to Nuxt.
- Host: GitHub
- URL: https://github.com/samk-dev/astratto-ui
- Owner: samk-dev
- License: mit
- Created: 2023-06-03T12:43:11.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-17T21:06:44.000Z (almost 3 years ago)
- Last Synced: 2025-03-27T02:08:29.186Z (over 1 year ago)
- Topics: nuxt-module, nuxtjs, ui-library, uikit
- Language: TypeScript
- Homepage:
- Size: 9.18 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Astratto UI
⚠️ Library still under development ⚠️
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
Yes, yet another UI library. Built on top of UIkit 3, it's exclusive to Nuxt.
It's the successor of my old `private library with support for nuxt2`. I usually use it in clients work.
Nuxt 3 came out so the need for an upgrade is necessary, so why not a re-write and open it for everyone?
## Features
- Built on top of UIkit 3
- Very light weight && elegant
- Modular, use what only what's needed
## Quick Setup
1. Add `astratto-ui` dependency to your project
```bash
# Using pnpm
pnpm add -D @samk-dev/astratto-ui
# Using yarn
yarn add --dev @samk-dev/astratto-ui
# Using npm
npm install --save-dev @samk-dev/astratto-ui
```
2. Add `@samk-dev/astratto-ui` to the `modules` section of `nuxt.config.ts`
```js
export default defineNuxtConfig({
modules: ['@samk-dev/astratto-ui']
})
```
That's it! You can now use Astratto UI in your Nuxt app ✨
## Development
Clone the repository and initialize submodules
```bash
git clone --recursive https://github.com/samk-dev/astratto-ui
```
then
```bash
# Install dependencies
pnpm install
# Generate type stubs
pnpm run dev:prepare
# Develop with the playground
pnpm run dev
# Build the playground
pnpm run dev:build
# Run ESLint
pnpm run lint
# Run Vitest
pnpm run test
pnpm run test:watch
# Release new version
pnpm run release
```
[npm-version-src]: https://img.shields.io/npm/v/astratto-ui/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/astratto-ui
[npm-downloads-src]: https://img.shields.io/npm/dm/astratto-ui.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/astratto-ui
[license-src]: https://img.shields.io/npm/l/astratto-ui.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/astratto-ui
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com