/nuxt-module-template

A template for Nuxt Modules with Bun

Primary LanguageTypeScriptMIT LicenseMIT

⚗️ Nuxt Module Template

CI npm version License: MIT

🚀 Welcome to Hebilicious Nuxt Module Starter Template!

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

Batteries Included

  • 📦 bun monorepo
  • 🏗️ 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 bun for module development :

bun i

📦 Contributing

Contributions, issues and feature requests are welcome!

  1. Fork this repo

  2. Install bun.

  3. Use bun i at the mono-repo root.

  4. Make modifications and follow conventional commits.

  5. Open a PR 🚀🚀🚀