jmartindf/LetterFeed
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Activity
Convert email newsletters into RSS feeds https://github.com/LeonMusCoden/LetterFeed
67 commits 1 branch 0 tags 1.6 MiB
Find a file
Exact
Matt 2739fbc897
add job to scheduler instead of running immediately (#23) 
* add job to scheduler instead of running immediately

* fix test

* Apply suggestions from code review

* linting
2025-10-21 22:23:48 +02:00
.github/workflows fix: pin python 3.13 in CI 2025-10-11 17:52:30 +02:00
backend add job to scheduler instead of running immediately (#23) 2025-10-21 22:23:48 +02:00
frontend fix: #20 2025-09-21 19:38:58 +02:00
.env.example feat: configurable backend url 2025-07-22 19:04:32 +02:00
.gitignore v0.1.0 2025-07-15 22:54:35 +02:00
.pre-commit-config.yaml chore: introduce alembic 2025-07-17 17:25:06 +02:00
docker-compose.dev.yml feat: configurable backend url 2025-07-22 19:04:32 +02:00
docker-compose.yml feat: configurable backend url 2025-07-22 19:04:32 +02:00
GEMINI.md feat: authentication 2025-07-19 10:12:11 +02:00
LICENSE Create LICENSE 2025-07-16 10:05:30 +02:00
Makefile fix: env vars respected by make dev #10 2025-08-06 21:05:30 +02:00
README.md docs: update readme 2025-07-22 19:04:50 +02:00
screenshot.png docs: update readme 2025-07-22 19:04:50 +02:00

README.md

LetterFeed

LetterFeed is a self-hosted application that transforms your email newsletters into RSS feeds.

It periodically scans your email inbox via IMAP for new emails from the senders you've configured. When it finds a new email, it processes it, and adds it as a new entry to the corresponding newsletter's RSS feed.

Getting Started

Prerequisites

  1. An existing mailbox with IMAP over SSL on port 993.
  2. Docker and Docker Compose installed on your system.

Installation

  1. Clone the repository:

    git clone https://github.com/LeonMusCoden/letterfeed.git
cd letterfeed

  2. Configure environment variables:

    Settings related to IMAP, email processing, and username/password can be set via env variables or the UI. All other settings have to be set via env vars. Settings set in the .env file are locked in the UI.

    cp .env.example .env

    Edit the .env file with your specific settings. All settings are explained in the .env.example.

  3. Run the Docker containers:

    docker compose up -d