Reddit Newsletter

Transform Reddit into a personalized daily or weekly newsletter, delivered to your Kindle! Modified from jstriblet's Reddit-to-Kindle program to add article integration and other features.

Quick Start

1. Clone and install:

   git clone https://github.com/popjam/Reddit-Newsletter.git
   cd Reddit-Newsletter
   npm install

2. Run the interactive setup:

   npm run setup

   The setup wizard will configure email, Reddit settings, and daily scheduling.

3. Generate your first newsletter:

   npm start

That's it! Your Reddit newsletter will be generated and sent to your Kindle.

See SETUP.md for detailed Windows, Linux, and macOS instructions.

Description

Reddit-Newsletter is a program that converts Reddit content into a formatted EPUB organized by subreddits. You can specify any subreddits you want to be included in the newsletter, the time range to fetch posts from, the sorting method, how comments are displayed, and more. It will attempt to fetch the articles and self posts so you don't need to use the inbuilt browser.

Cover	Main Contents	Subreddit Title Page

Subreddit Contents	Post View	Article View

Installation & Setup

Prerequisites

• Node.js 18+
• npm or yarn

Step-by-Step Setup

1. Clone the repository:

   git clone https://github.com/jstriblet/Reddit-Newsletter.git
   cd Reddit-Newsletter

2. Install dependencies:

   npm install

3. Run the interactive setup wizard:

   npm run setup

The setup wizard will guide you through:

Email Configuration

• Gmail setup: Create an app password (tutorial here).
• GMX setup: Simple username/password configuration (create gmx account here).
• Kindle email: Instructions on finding your Kindle email and adding your sender to the approved list

Reddit OAuth (Recommended)

• Why use OAuth: Higher rate limits (60 requests/minute vs 10) and speeds (Setup here).
• Optional: You can skip this for basic usage

Newsletter Preferences

• Subreddit selection: Enter your favorite subreddits (e.g., worldnews, technology, AskReddit)
• Posts per subreddit: How many posts to include
• Comments per post: How many top comments to include
• Time period: Daily, weekly, monthly, or yearly top posts

Manual Configuration (Advanced)

If you prefer manual setup, you can edit user-config.json directly:

// Example configuration
"subreddits": [
      "popular",
      "all",
      "worldnews",
      "hotdogs",
      "digitalminimalism",
      "denmark",
      "aliens",
      "chess",
      "AskHistorians",
      "houseplants",
      {
        "name": "AmItheAsshole",
        "sort": "controversial"
      }
    ],

📚 Usage

Basic Commands

# Generate and send newsletter
npm start

# Reconfigure settings
npm run setup

# Show help
npm run help

Email Providers

Gmail Setup:

1. Enable 2-Factor Authentication
2. Go to Google Account Settings > Security > App Passwords
3. Generate a new app password
4. Use this password (not your regular Gmail password)

GMX Setup:

1. Enable POP3/IMAP in GMX settings
2. Use your regular GMX password

Kindle Email Setup

1. Find your Kindle email: Kindle App > Settings > Send to Kindle Email
2. Add your email to approved senders: Amazon Account > Manage Your Content and Devices > Personal Document Settings

Automation

Cron Jobs (Linux/Mac)

Set up automatic daily newsletters:

# Edit crontab
crontab -e

# Add this line for daily 8 AM delivery
0 8 * * * cd /path/to/reddit-newsletter && npm start

Windows Task Scheduler

1. Open Task Scheduler
2. Create Basic Task
3. Set trigger (daily, weekly, etc.)
4. Set action to "Start a program" and in the "Program/script" box, browse to and select the run-newsletter.bat file located in your project folder.

Configuration Options

Configurations can be made in user-config.json. Subreddit configurations can be global or subreddit specific.

Subreddit Settings

• commentsPerPost: Amount of top level comments for each post.
• sort: hot, new, top, controversial, best, rising
• timeframe: hour, day, week, month, year, all
• includeInternalLinks: Include/exclude self posts
• skipUnfetchableArticles: If the articles text cannot be fetched, skip the post.
• commentStyle: threaded or nested. Nested will include all child comments up to the specified depth. Threaded will only include the top "chain" of comments up to the specified depth, better simulating a conversation.
• minCommentLength: Will skip comments under this amount of characters. In threaded, only applies to top level comments.

General Settings

• imageOptimizationPreset: default, aggressive, extreme

EPUB Settings

• simplifiedTOC: Show only subreddit sections (default: true)
• hierarchicalTOC: Show only subreddit sections (default: true)
• title: Personalize your newsletter title

Other Settings

Rate limiting and timeout, image size, and cover generation settings can be modified in config.js.

License

This project is licensed under the MIT License - see the LICENSE file for details.