mirror of
https://github.com/bitinflow/ui.git
synced 2026-03-13 13:45:59 +00:00
91 lines
1.8 KiB
Markdown
91 lines
1.8 KiB
Markdown
<!--
|
|
Get your module up and running quickly.
|
|
|
|
Find and replace all on all files (CMD+SHIFT+F):
|
|
- Name: My Module
|
|
- Package name: my-module
|
|
- Description: My new Nuxt module
|
|
-->
|
|
|
|
# My Module
|
|
|
|
[![npm version][npm-version-src]][npm-version-href]
|
|
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
|
[![License][license-src]][license-href]
|
|
|
|
> My new Nuxt module
|
|
|
|
- [✨ Release Notes](/CHANGELOG.md)
|
|
<!-- - [📖 Documentation](https://example.com) -->
|
|
|
|
## Features
|
|
|
|
<!-- Highlight some of the features your module provide here -->
|
|
- ⛰ Foo
|
|
- 🚠 Bar
|
|
- 🌲 Baz
|
|
|
|
## Quick Setup
|
|
|
|
1. Add `@bitinflow/ui` dependency to your project
|
|
|
|
```bash
|
|
# Using pnpm
|
|
pnpm add -D @bitinflow/ui
|
|
|
|
# Using yarn
|
|
yarn add --dev @bitinflow/ui
|
|
|
|
# Using npm
|
|
npm install --save-dev @bitinflow/ui
|
|
```
|
|
|
|
2. Add `@bitinflow/ui` to the `modules` section of `nuxt.config.ts`
|
|
|
|
```js
|
|
export default defineNuxtConfig({
|
|
modules: [
|
|
'@bitinflow/ui',
|
|
'@'
|
|
]
|
|
})
|
|
```
|
|
|
|
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
|
|
```
|
|
|
|
<!-- Badges -->
|
|
[npm-version-src]: https://img.shields.io/npm/v/@bitinflow/ui/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
[npm-version-href]: https://npmjs.com/package/@bitinflow/ui
|
|
|
|
[npm-downloads-src]: https://img.shields.io/npm/dm/@bitinflow/ui.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
[npm-downloads-href]: https://npmjs.com/package/@bitinflow/ui
|
|
|
|
[license-src]: https://img.shields.io/npm/l/@bitinflow/ui.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
[license-href]: https://npmjs.com/package/@bitinflow/ui
|