//nuxt-module-templatebyHebilicious

nuxt-module-template

A template for Nuxt Modules with Pnpm and Bun

16
2
16
4
TypeScript

βš—οΈ Nuxt Module Template

CI
License: MIT

πŸš€ Welcome to Hebilicious Nuxt Module Starter Template!

This is a Pnpm and Bun powered Nuxt Module Repo Template Starter.
It comes with a base module that you can use to start your own module.

Batteries Included

  • πŸ“¦ pnpm monorepo
  • πŸ“¦ Bun script runner
  • πŸ—οΈ Build Nuxt Module with nuxt-build-module
  • πŸ— ESM/CJS valid package, with MTS and CTS declaration files.
  • πŸ“ Docs with vitepress
  • βœ… Tests with vitest
  • πŸ”¨ Publish with pnpm
  • πŸ”„ CI with Github Actions and bun
  • πŸš€ Trigger NPM release + changelog from CLI
  • πŸ“ Conventional commits
  • πŸ”„ Renovate config

πŸ“¦ Installation

Use pnpm and bun for module development :

pnpm i

πŸš€ Getting Started

Do a search and replace for @hebilicious/nuxt-module-template and nuxt-module-template and replace with your scope and module name.

πŸ“¦ Contributing

Contributions, issues and feature requests are welcome!

  1. Fork this repo

  2. Install bun.

  3. Intall pnpm corepack enable && pnpm corepack use pnpm@latest

  4. Use pnpm i at the mono-repo root.

  5. Make modifications and follow conventional commits.

  6. Open a PR πŸš€πŸš€πŸš€

[beta]v0.14.0