https://github.com/wefixers/nuxt-mail
A Nuxt module that makes mail easy
https://github.com/wefixers/nuxt-mail
Last synced: 3 months ago
JSON representation
A Nuxt module that makes mail easy
- Host: GitHub
- URL: https://github.com/wefixers/nuxt-mail
- Owner: wefixers
- Created: 2023-05-30T17:56:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-30T20:36:37.000Z (about 2 years ago)
- Last Synced: 2025-02-27T14:42:14.209Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 113 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Nuxt Mail
[![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]
A Nuxt module that makes mail easy for doing amazing things.
- [✨ Release Notes](/CHANGELOG.md)
## Features
- ⛰ Foo
- 🚠 Bar
- 🌲 Baz
## Quick Setup
1. Add `@fixers/nuxt-mail` dependency to your project
```bash
# Using pnpm
pnpm add -D @fixers/nuxt-mail
# Using yarn
yarn add --dev @fixers/nuxt-mail
# Using npm
npm install --save-dev @fixers/nuxt-mail
```
2. Add `@fixers/nuxt-mail` to the `modules` section of `nuxt.config.ts`
```js
export default defineNuxtConfig({
modules: [
'@fixers/nuxt-mail'
]
})
```
That's it! You can now use Nuxt Mail in your Nuxt app ✨
## Development
```bash
# Install dependencies
npm install
# Generate type stubs
npm run dev:prepare
# Develop with the playground
npm run dev
# Build the playground
npm run dev:build
# Run ESLint
npm run lint
# Run Vitest
npm run test
npm run test:watch
# Release new version
npm run release
```
[npm-version-src]: https://img.shields.io/npm/v/@fixers/nuxt-mail/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@fixers/nuxt-mail
[npm-downloads-src]: https://img.shields.io/npm/dm/@fixers/nuxt-mail.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@fixers/nuxt-mail
[license-src]: https://img.shields.io/npm/l/@fixers/nuxt-mail.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@fixers/nuxt-mail
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com