https://github.com/tdolsen/nuxt-mailpit
Nuxt devtools Mailpit web UI integration
https://github.com/tdolsen/nuxt-mailpit
mailpit nuxt
Last synced: 4 months ago
JSON representation
Nuxt devtools Mailpit web UI integration
- Host: GitHub
- URL: https://github.com/tdolsen/nuxt-mailpit
- Owner: tdolsen
- License: mit
- Created: 2024-02-19T17:40:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T04:38:01.000Z (about 2 years ago)
- Last Synced: 2025-11-18T07:08:08.486Z (7 months ago)
- Topics: mailpit, nuxt
- Language: TypeScript
- Homepage:
- Size: 93.8 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Nuxt Mailpit
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
Integrate the [Mailpit][mailpit-href] web UI effortlessly in the [Nuxt][nuxt-href] devtools.
## Features
- 🧙 **Devtools integration**: Access the Mailpit web UI directly from Nuxt devtools.
## Quick Setup
1. Add `nuxt-mailpit` dependency to your project
```bash
npx nuxi@latest module add mailpit
```
2. Add `nuxt-mailpit` to the `modules` section of `nuxt.config.ts`
```js
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
```ts
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
```bash
# 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
```
[npm-version-src]: https://img.shields.io/npm/v/nuxt-mailpit/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/nuxt-mailpit
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-mailpit.svg?style=flat&colorA=020420&colorB=00DC82
[npm-downloads-href]: https://npmjs.com/package/nuxt-mailpit
[license-src]: https://img.shields.io/npm/l/nuxt-mailpit.svg?style=flat&colorA=020420&colorB=00DC82
[license-href]: https://npmjs.com/package/nuxt-mailpit
[mailpit-href]: https://mailpit.axllent.org/
[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
[nuxt-href]: https://nuxt.com