{"repo":"rykov/paperboy","free":true,"listed":false,"github":"https://github.com/rykov/paperboy","clone":"git clone https://github.com/rykov/paperboy.git","description":"💌💨 Email Campaign Delivery built with GoLang inspired by GoHugo","language":"Go","stars":503,"topics":["email","email-campaigns","email-marketing","email-newsletter","go","html-emails","paperboy"],"license":null,"category":"email_marketing","readme_excerpt":"![Paperboy](https://www.paperboy.email/images/banner.jpg)\n\nA Fast & Modern Email Campaign Engine built in [Go][].\n\n[Website](https://www.paperboy.email/) |\n[Documentation](https://www.paperboy.email/docs/introduction/) |\n[Installation Guide](https://www.paperboy.email/docs/installation/)\n\n[![Version Badge](https://badge.fury.io/mdy/github.com%2Frykov%2Fpaperboy.svg)](https://melody.sh/github.com/rykov/paperboy)\n[![Go Report Card](https://goreportcard.com/badge/github.com/rykov/paperboy)](https://goreportcard.com/report/github.com/rykov/paperboy)\n[![Build Status](https://github.com/rykov/paperboy/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/paperboy/actions/workflows/tests.yml)\n\n## Overview\n\nPaperboy is complete email engine that helps you get the most out of your\ncampaigns. It allows you to craft shared templates, and then quickly author\nand deliver multi-format campaigns.\n\nPaperboy is command-line tool that consumes a [source directory][structure]\nas input to render and send email campaigns via any SMTP service.  By placing\ntemplates, lists, and content in a predefined [directory structure][structure],\nPaperboy will render markup, inline styles, wrap layouts, and more to deliver\nmodern (yet legacy-compatible) newsletters and announcements.\n\n**Complete documentation is available at [Paperboy Documentation][docs].**\n\n## Installing binaries\n\nCurrently, we provide [pre-built binaries][releases] for Linux and macOS.\nPaperboy is a single binary with no external dependencies.\n\nJust run `./paperboy help` and you're [ready to go][quickstart].\n\n## Installing from source\n\nYou can also build and install Paperboy from source. The only requirement is to\nhave a working installation of [Go][] 1.11+. With those in place, the following\ncommands will install Paperboy to `$GOPATH/bin`:\n\n```bash\n$ git clone https://github.com/rykov/paperboy.git\n$ cd paperboy\n$ make install\n```\n\nAnd please make sure `$GOPATH/bin` is in your `$PATH`.\n\nIf you receive a `go: modules disabled` error due to your project being inside\nof $GOPATH, you will have to force-enable go modules support:\n\n```bash\nGO111MODULE=on make install\n```\n\n## Contributing to Paperboy\n\nWe welcome all contribution to Paperboy: documentation, bug reporst, feature\nideas, blog posts, promotion, etc\n\nYou can start here:\n\n- [Report a bug](https://github.com/rykov/paperboy/issues/new)\n- [Fork to contribute](https://github.com/rykov/paperboy/fork)\n- [Improve documentation](https://github.com/rykov/paperboyDocs)\n- [Logos & Design](https://github.com/rykov/paperboyDocs)\n\n## Inspiration and credits\n\nPaperboy aims to bring to email the ease of use and control we love from static\nsite generators. We particularly want to thank [Hugo][] authors for much of\nthe inspiration and a number of our [dependencies][].\n\nThe banner photo is by [Mathyas Kurmann](https://unsplash.com/@mathyaskurmann)\n\n[Go]: https://golang.org/\n[Hugo]: https://gohugo.io/\n[quickstart]: https://www.paperboy.email/docs/quick-start/\n[structure]: https://www.paperboy.email/docs/source-structure/\n[releases]: https://github.com/rykov/paperboy/releases\n[docs]: https://www.paperboy.email/docs/introduction/\n[melody]: https://github.com/mdy/melody\n","default_branch":"main","files":122,"tree":[".github/workflows/goreleaser.yml",".github/workflows/tests.yml",".gitignore",".goreleaser.yml","CHANGELOG.md","Makefile","README.md","client/send.go","client/send_test.go","cmd/new.go","cmd/new_test.go","cmd/preview.go","cmd/preview_test.go","cmd/root.go","cmd/root_test.go","cmd/send.go","cmd/send_test.go","cmd/server.go","cmd/server_test.go","cmd/verify.go","cmd/verify_test.go","cmd/version.go","cmd/version_test.go","config/config.go","config/config_test.go","config/fs.go","config/fs_test.go","go.mod","go.sum","mail/campaign.go","mail/campaign_test.go","mail/context.go","mail/context_test.go","mail/dkim.go","mail/dkim_test.go","mail/inliner.go","mail/inliner_test.go","mail/recipients.go","mail/recipients_test.go","mail/schema.go","mail/schema_test.go","mail/send/memory.go","mail/send/queue.go","mail/send/queue_test.go","mail/send/sender.go","mail/send/sender_test.go","mail/sender.go","mail/sender_test.go","mail/verify.go","mail/verify_test.go","main.go","parser/email.go","parser/email_test.go","parser/frontmatter.go","parser/frontmatter_test.go","parser/long_text_test.md","parser/parse_frontmatter_test.go","server/handler.go","server/handler_test.go","server/listings.go","server/listings_test.go","server/resolver.go","server/schema.go","server/schema_test.go","server/send.go","server/send_test.go","ui/.editorconfig","ui/.ember-cli","ui/.gitignore","ui/.prettierignore","ui/.prettierrc.js","ui/.stylelintignore","ui/.stylelintrc.js","ui/.template-lintrc.js","ui/.watchmanconfig","ui/app/app.js","ui/app/components/html-preview/index.hbs","ui/app/components/html-preview/index.js","ui/app/components/partials/nav.hbs","ui/app/components/partials/with-header.hbs","ui/app/controllers/preview/index.js","ui/app/controllers/preview/render.js","ui/app/deprecation-workflow.js","ui/app/gql/queries/index.graphql","ui/app/gql/queries/info.graphql","ui/app/gql/queries/preview.graphql","ui/app/helpers/contains.js","ui/app/index.html","ui/app/models/.gitkeep","ui/app/router.js","ui/app/routes/index.js","ui/app/routes/preview/index.js","ui/app/routes/preview/render.js","ui/app/services/apollo.js","ui/app/templates/_styles/app.scss","ui/app/templates/_styles/tailwind.css","ui/app/templates/application.hbs","ui/app/templates/preview.hbs","ui/app/templates/preview/error.hbs","ui/app/templates/preview/index.hbs","ui/app/templates/preview/render.hbs","ui/config/ember-cli-update.json","ui/config/embroider.js","ui/config/environment.js","ui/config/optional-features.json","ui/config/postcss.js","ui/config/targets.js","ui/ember-cli-build.js","ui/eslint.config.mjs","ui/package.json","ui/public/robots.txt","ui/testem.js","ui/tests/helpers/index.js","ui/tests/index.html","ui/tests/integration/.gitkeep","ui/tests/integration/components/bbq-wtf/component-test.js","ui/tests/integration/components/wtf-bbq-test.js","ui/tests/test-helper.js","ui/tests/unit/.gitkeep","ui/ui_dist.go","ui/ui_none.go","ui/yarn.lock"],"storefront":"/r/rykov","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/rykov/paperboy/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}