https://github.com/openmost/nuxt-ui-kit
Openmost UI kit for NUXT 3
https://github.com/openmost/nuxt-ui-kit
openmost openmost-ui
Last synced: 4 months ago
JSON representation
Openmost UI kit for NUXT 3
- Host: GitHub
- URL: https://github.com/openmost/nuxt-ui-kit
- Owner: openmost
- Created: 2023-10-13T13:21:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-15T18:38:03.000Z (over 1 year ago)
- Last Synced: 2025-07-27T18:41:12.951Z (10 months ago)
- Topics: openmost, openmost-ui
- Language: Vue
- Homepage: https://openmost.io
- Size: 1.02 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# My Module
[![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]
My new Nuxt module for doing amazing things.
- [✨ Release Notes](/CHANGELOG.md)
## Features
- ⛰ Foo
- 🚠 Bar
- 🌲 Baz
## Quick Setup
1. Add `my-module` dependency to your project
```bash
# Using pnpm
pnpm add -D my-module
# Using yarn
yarn add --dev my-module
# Using npm
npm install --save-dev my-module
```
2. Add `my-module` to the `modules` section of `nuxt.config.ts`
```js
export default defineNuxtConfig({
modules: [
'my-module'
]
})
```
That's it! You can now use My Module in your Nuxt app ✨
## Development
```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
```
[npm-version-src]: https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/my-module
[npm-downloads-src]: https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/my-module
[license-src]: https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/my-module
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com