https://github.com/Hebilicious/nuxt-module-template

A template for Nuxt Modules with Bun
https://github.com/Hebilicious/nuxt-module-template

bun nuxt nuxt-module nuxt3 starter-template template

Last synced: 4 months ago
JSON representation

A template for Nuxt Modules with Bun

• Host: GitHub
• URL: https://github.com/Hebilicious/nuxt-module-template
• Owner: Hebilicious
• License: mit
• Created: 2023-05-31T12:04:41.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-05T01:58:14.000Z (4 months ago)
• Last Synced: 2024-09-06T10:10:06.838Z (4 months ago)
• Topics: bun, nuxt, nuxt-module, nuxt3, starter-template, template
• Language: TypeScript
• Homepage:
• Size: 1.47 MB
• Stars: 14
• Watchers: 1
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# ⚗️ Nuxt Module Template

[![CI](https://github.com/Hebilicious/authjs-nuxt/actions/workflows/ci.yaml/badge.svg)](https://github.com/Hebilicious/authjs-nuxt/actions/workflows/ci.yaml)

[![npm version](https://badge.fury.io/js/@hebilicious%2Fauthjs-nuxt.svg)](https://badge.fury.io/js/@hebilicious%2Fauthjs-nuxt)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/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](https://bun.sh/docs/installation) for module development :

```bash

bun i 

```

## 📦 Contributing

Contributions, issues and feature requests are welcome!

1. Fork this repo

2. [Install `bun`.](https://bun.sh/docs/installation)

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

4. Make modifications and follow conventional commits.

5. Open a PR 🚀🚀🚀