Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/baroshem/nuxt-newsletter
✉️ Nuxt module for first class integration with popular newsletter providers
https://github.com/baroshem/nuxt-newsletter
buttondown mailchimp newsletter nuxt nuxt-module nuxtjs revue vue
Last synced: 12 days ago
JSON representation
✉️ Nuxt module for first class integration with popular newsletter providers
- Host: GitHub
- URL: https://github.com/baroshem/nuxt-newsletter
- Owner: Baroshem
- License: mit
- Created: 2022-06-30T14:24:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-23T21:25:37.000Z (over 1 year ago)
- Last Synced: 2024-10-11T16:40:21.725Z (27 days ago)
- Topics: buttondown, mailchimp, newsletter, nuxt, nuxt-module, nuxtjs, revue, vue
- Language: TypeScript
- Homepage: https://nuxt-newsletter.netlify.app/
- Size: 1.54 MB
- Stars: 57
- Watchers: 1
- Forks: 6
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://nuxt-newsletter.netlify.app)
# nuxt-newsletter
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![License][license-src]][license-href]
> Newsletter module for [Nuxt 3](https://v3.nuxtjs.org)
- [✨ Release Notes](https://github.com/baroshem/nuxt-newsletter/releases)
- [📖 Read the documentation](https://nuxt-newsletter.netlify.app)
## Features
- Nuxt 3 ready
- Easy integration with Mailchimp, Revue, Buttondown
- Unstyled NewletterForm.vue component
- Handy useNewsletterSubscribe composable
- TypeScript support
[📖 Read the documentation](https://nuxt-newsletter.netlify.app)
## Setup
```sh
yarn add nuxt-newsletter # yarn
npm i nuxt-newsletter # npm
```
## Basic usage
Firstly, you need to add `nuxt-newsletter` to your Nuxt config.
```javascript
// nuxt.config.js
{
modules: [
"nuxt-newsletter",
],
newsletter: {
// mailchimp | revue | buttondown
: {
// options like apiKey
}
}
}
```
Then you can start using `nuxt-newsletter` in your app!
```vue
```
## Development
1. Clone this repository
2. Install dependencies using `yarn install` or `npm install`
3. Prepare playground environment using `yarn dev:prepare` or `npm run dev:prepare`
4. Start development server using `yarn dev` or `npm run dev`
## License
[MIT License](./LICENSE)
[npm-version-src]: https://img.shields.io/npm/v/nuxt-newsletter/latest.svg
[npm-version-href]: https://npmjs.com/package/nuxt-newsletter
[npm-downloads-src]: https://img.shields.io/npm/dt/nuxt-newsletter.svg
[npm-downloads-href]: https://npmjs.com/package/nuxt-newsletter
[github-actions-ci-src]: https://github.com/baroshem/nuxt-newsletter/actions/workflows/ci.yml/badge.svg
[github-actions-ci-href]: https://github.com/baroshem/nuxt-newsletter/actions?query=workflow%3Aci
[license-src]: https://img.shields.io/npm/l/nuxt-newsletter.svg
[license-href]: https://npmjs.com/package/nuxt-newsletter