nuxt-mailpit

Nuxt Mailpit

Integrate the Mailpit web UI effortlessly in the Nuxt devtools.

Features

• 🧙 Devtools integration: Access the Mailpit web UI directly from Nuxt devtools.

Quick Setup

1. Add nuxt-mailpit dependency to your project

npx nuxi@latest module add mailpit

2. Add nuxt-mailpit to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-mailpit'
  ]
})

3. Ensure you have Mailpit installed and running.

That's it! You can now use Mailpit in your Nuxt app ✨

Module options

export default defineNuxtConfig({
  modules: ["nuxt-mailpit"],
  mailpit: {
    // Enable or disable the Mailpit web UI in devtools
    devtools: true,
    // The URL of the Mailpit web UI
    webUiUrl: "http://localhost:8025",
  }
})

Contributing

Suggestions for new features, bug reports and pull requests are welcome!

Development

# Install dependencies
pnpm install

# Generate type stubs
pnpm run dev:prepare

# Develop with the playground
pnpm run dev

# Build the playground
pnpm run dev:build

# Run ESLint
pnpm run lint

# Run Vitest
pnpm run test
pnpm run test:watch

# Release new version
pnpm run release