Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.55 KB

README.md

File metadata and controls

51 lines (33 loc) · 1.55 KB

⚗️ 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 🚀🚀🚀