{"id":22489603,"url":"https://github.com/Baroshem/nuxt-newsletter","last_synced_at":"2025-08-02T21:33:10.471Z","repository":{"id":41317929,"uuid":"509112305","full_name":"Baroshem/nuxt-newsletter","owner":"Baroshem","description":"✉️ Nuxt module for first class integration with popular newsletter providers","archived":false,"fork":false,"pushed_at":"2023-04-23T21:25:37.000Z","size":1615,"stargazers_count":58,"open_issues_count":18,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-01T06:54:12.123Z","etag":null,"topics":["buttondown","mailchimp","newsletter","nuxt","nuxt-module","nuxtjs","revue","vue"],"latest_commit_sha":null,"homepage":"https://nuxt-newsletter.netlify.app/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Baroshem.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-30T14:24:44.000Z","updated_at":"2024-11-06T13:40:51.000Z","dependencies_parsed_at":"2024-06-19T17:39:06.238Z","dependency_job_id":"52cef483-e3d4-45c9-87f8-b0db35033955","html_url":"https://github.com/Baroshem/nuxt-newsletter","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Baroshem%2Fnuxt-newsletter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Baroshem%2Fnuxt-newsletter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Baroshem%2Fnuxt-newsletter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Baroshem%2Fnuxt-newsletter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Baroshem","download_url":"https://codeload.github.com/Baroshem/nuxt-newsletter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228500382,"owners_count":17930049,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["buttondown","mailchimp","newsletter","nuxt","nuxt-module","nuxtjs","revue","vue"],"created_at":"2024-12-06T17:20:15.324Z","updated_at":"2024-12-06T17:22:44.916Z","avatar_url":"https://github.com/Baroshem.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"[![nuxt-newsletter](https://nuxt-newsletter.netlify.app/preview.png)](https://nuxt-newsletter.netlify.app)\n\n# nuxt-newsletter\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]\n[![License][license-src]][license-href]\n\n\u003e Newsletter module for [Nuxt 3](https://v3.nuxtjs.org)\n\n- [✨ \u0026nbsp;Release Notes](https://github.com/baroshem/nuxt-newsletter/releases)\n- [📖 \u0026nbsp;Read the documentation](https://nuxt-newsletter.netlify.app)\n\n## Features\n\n- Nuxt 3 ready\n- Easy integration with Mailchimp, Revue, Buttondown\n- Unstyled NewletterForm.vue component\n- Handy useNewsletterSubscribe composable\n- TypeScript support\n\n[📖 \u0026nbsp;Read the documentation](https://nuxt-newsletter.netlify.app)\n\n## Setup\n\n```sh\nyarn add nuxt-newsletter # yarn\nnpm i nuxt-newsletter # npm\n```\n\n## Basic usage\n\nFirstly, you need to add `nuxt-newsletter` to your Nuxt config.\n\n```javascript\n// nuxt.config.js\n\n{\n    modules: [\n        \"nuxt-newsletter\",\n    ],\n    newsletter: {\n      // mailchimp | revue | buttondown\n      \u003cYOUR_NEWSLETTER_PROVIDER\u003e: {\n        // options like apiKey\n      }\n    }\n}\n```\n\nThen you can start using `nuxt-newsletter` in your app!\n\n```vue\n\u003ctemplate\u003e\n  \u003cdiv\u003e\n    \u003cnewsletter-form /\u003e\n  \u003c/div\u003e\n\u003c/template\u003e\n```\n\n## Development\n\n1. Clone this repository\n2. Install dependencies using `yarn install` or `npm install`\n3. Prepare playground environment using `yarn dev:prepare` or `npm run dev:prepare`\n4. Start development server using `yarn dev` or `npm run dev`\n\n## License\n\n[MIT License](./LICENSE)\n\n\u003c!-- Badges --\u003e\n\n[npm-version-src]: https://img.shields.io/npm/v/nuxt-newsletter/latest.svg\n[npm-version-href]: https://npmjs.com/package/nuxt-newsletter\n[npm-downloads-src]: https://img.shields.io/npm/dt/nuxt-newsletter.svg\n[npm-downloads-href]: https://npmjs.com/package/nuxt-newsletter\n[github-actions-ci-src]: https://github.com/baroshem/nuxt-newsletter/actions/workflows/ci.yml/badge.svg\n[github-actions-ci-href]: https://github.com/baroshem/nuxt-newsletter/actions?query=workflow%3Aci\n[license-src]: https://img.shields.io/npm/l/nuxt-newsletter.svg\n[license-href]: https://npmjs.com/package/nuxt-newsletter\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBaroshem%2Fnuxt-newsletter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBaroshem%2Fnuxt-newsletter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBaroshem%2Fnuxt-newsletter/lists"}