An open API service indexing awesome lists of open source software.

https://github.com/blouflashdb/nimiq-nuxt-module

A Nuxt 3 module for @nimiq/core
https://github.com/blouflashdb/nimiq-nuxt-module

cryptocurrency nimiq nuxtjs

Last synced: 17 days ago
JSON representation

A Nuxt 3 module for @nimiq/core

Awesome Lists containing this project

README

        

# Nimiq Nuxt 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]

A Nuxt module that lets you use the Nimiq Light Client without configuration.

- [✨  Release Notes](/CHANGELOG.md)
- [🏀 Online playground](https://stackblitz.com/github/blouflashdb/nimiq-nuxt-module?file=playground%2Fapp.vue)

## Features

- 0 Configuration
- useNimiq() composable

## Quick Setup

Install the module to your Nuxt application with one command:

```bash
npx nuxi module add nimiq-nuxt-module
```

That's it! You can now use nimiq-nuxt-module in your Nuxt app

## Contribution

Local 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/nimiq-nuxt-module/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/nimiq-nuxt-module

[npm-downloads-src]: https://img.shields.io/npm/dm/nimiq-nuxt-module.svg?style=flat&colorA=020420&colorB=00DC82
[npm-downloads-href]: https://npm.chart.dev/nimiq-nuxt-module

[license-src]: https://img.shields.io/npm/l/nimiq-nuxt-module.svg?style=flat&colorA=020420&colorB=00DC82
[license-href]: https://npmjs.com/package/nimiq-nuxt-module

[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
[nuxt-href]: https://nuxt.com