https://github.com/arashsheyda/nuxt-devtools-rpc-starter

Nuxt DevTools RPC Starter for creating DevTools module
https://github.com/arashsheyda/nuxt-devtools-rpc-starter

Last synced: 15 days ago
JSON representation

Nuxt DevTools RPC Starter for creating DevTools module

• Host: GitHub
• URL: https://github.com/arashsheyda/nuxt-devtools-rpc-starter
• Owner: arashsheyda
• Created: 2023-09-27T16:53:02.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-28T23:43:03.000Z (about 1 year ago)
• Last Synced: 2024-10-09T07:22:11.256Z (about 1 month ago)
• Language: TypeScript
• Size: 8.79 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

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 integrated with the [Nuxt Devtools](https://github.com/nuxt/devtools).

- [✨  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 playground, with devtools client ui

npm run dev

# Develop with playground, with bundled client ui

npm run play:prod

# 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