https://github.com/eduardostuart/paperboy-template
🗞 A GitHub template that delivers new posts from your favorite sites by email.
https://github.com/eduardostuart/paperboy-template
feed github-actions github-template paperboy rss template
Last synced: 12 months ago
JSON representation
🗞 A GitHub template that delivers new posts from your favorite sites by email.
- Host: GitHub
- URL: https://github.com/eduardostuart/paperboy-template
- Owner: eduardostuart
- License: mit
- Created: 2022-03-02T20:57:27.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-11-27T11:57:33.000Z (over 2 years ago)
- Last Synced: 2025-04-13T11:59:26.014Z (12 months ago)
- Topics: feed, github-actions, github-template, paperboy, rss, template
- Language: Handlebars
- Homepage: https://github.com/eduardostuart/paperboy
- Size: 6.84 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# Paperboy template
A GitHub template that [delivers](.github/workflows/cron.yml) new posts from all your favorite sites by email.
## Usage
1. Click on `use this template`
2. Update the `subs.txt` file. Include your list of websites.
Example:
```
https://blog.laravel.com/feed
# https://news.mit.edu/rss/feed (this will be ignored)
https://blog.mozilla.org/feed
```
3. Set these environment variable values (`GitHub Secrets`):
```bash
SMTP_HOST="smtp.mailtrap.io" # SMTP host
SMTP_PORT=2525 # SMTP port
SMTP_USERNAME="username" # SMTP username
SMTP_PASSWORD="password" # SMTP password
SMTP_FROM="Paperboy " # the sender
MAIL_TO="email@domain.com" # the recipient
EMAIL_SUBJECT="Subject" # Email subject (optional)
```
4. Update `template.hbs` & `template_text.hbs` if you want to customize the email template.
5. Update `.github/workflows/cron.yml` if you want to change the frequency or time that you want to receive the email.
6. If you just want to test, trigger the `.github/workflows/manual.yml` GitHub Action.
## License
This code is distributed under the terms of MIT license.
See [LICENSE-MIT](LICENSE-MIT) for details.