# @marcoborsoi/nuxt-valtech-ui

> This application was built following the official [Nuxt Module Author Guide](https://v3.nuxtjs.org/guide/going-further/modules/).

Latest version **0.0.2** (published 2022-07-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install @marcoborsoi/nuxt-valtech-ui
pnpm add @marcoborsoi/nuxt-valtech-ui
yarn add @marcoborsoi/nuxt-valtech-ui
bun add @marcoborsoi/nuxt-valtech-ui
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2022-07-19 |
| First published | 2022-07-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | marcoborsoi |

## Links

- npm: https://www.npmjs.com/package/@marcoborsoi/nuxt-valtech-ui
- npm.io page: https://npm.io/package/@marcoborsoi/nuxt-valtech-ui

## Dependencies (2)

- [@nuxt/kit](https://npm.io/package/@nuxt/kit.md) ^3.0.0-rc.4
- [@marcoborsoi/valtech-ui](https://npm.io/package/@marcoborsoi/valtech-ui.md) ^0.0.2

## Recent versions

- 0.0.2 (latest) — 2022-07-19

## README

# Valtech UI Nuxt Module

This application was built following the official [Nuxt Module Author Guide](https://v3.nuxtjs.org/guide/going-further/modules/).

## Setup

You can use `npm`or `yarn`.

```bash
# install dependencies
yarn install

# build the library to be tested in playground
yarn dev:prepare

# to start playground in development mode
yarn dev

# build the app
yarn prepack
```

## Develop and test locally

In order to develop and test your module, use the [playground](./playground/) directory.

This application uses the components from the `valtech-ui` component library project. In order to add it as a dependency to this Nuxt module, please follow the 3 steps described in the section *Develop and test locally* of the `valtech-ui` component library project.

If you want to test the module in a Nuxt3 app locally:

1. In the root folder of this library, run `yarn link`. This will create a symbolic link to the library.
2. In the root folder of your client app, run `yarn link @valtech/nuxt-valtech-ui`. This will add the symbolic link to the `node_modules` folder in your client app.
3. You can now define `@valtech/nuxt-valtech-ui` in `nuxt.config.ts` of your Nuxt app.

```bash
import { defineNuxtConfig } from 'nuxt'

export default defineNuxtConfig({
  modules: [
    ['@valtech/nuxt-valtech-ui', { addPlugin: true }]
  ],
})
```

There is no need to add `@valtech/nuxt-valtech-ui` to your Nuxt app's dependency in this case.

If you made changes to the library, you will need to rebuild the library. Your Nuxt3 app shall hot reload when the building of library is completed.

---
_Source: https://npm.io/package/@marcoborsoi/nuxt-valtech-ui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._