angristan / larafeed

Feed reader for the web, built with Laravel and Vue

Larafeed

Larafeed is a simple feed reader.

Features

• RSS and Atom feed support
• Background feed updates
• Full-text search through a reactive search bar
• AI-generated summary of entries
• Favicon display
• GitHub-like sparkline graphs representing feed acitivity

Technical overview

• Backend build with Laravel 9
  • Architectured around Actions
• Vue.js 3 for the frontend
• Inertia.js that does the magic glue between Laravel and Vue.js
• Feed parsing is powered by SimplePie
  • Through willvincent/feeds
• Full text search with Laravel Scout, powered by Meilisearch
• Summary generation is powered by ChatGPT
  • Through openai-php/laravel
  • The prompt is truncated using the GPT3 tokenizer, implemeted in PHP in Gioni06/GPT3Tokenizer
• Supports multiple database engines (thanks to Laravel)
• Background jobs are powered by the Laravel scheduler, Laravel queues and Laravel Horizon
  • The queue system is powered by Redis
• Favicon fetching is powered by ash-jc-allen/favicon-fetcher
• Sparkline graphs are powered by brendt/php-sparkline
• The frontend uses Tailwind CSS with some plugins
  • Tailwind CSS Typography to render entry content
  • daisyUI to write less classes
  • Flowbite, for some components
• Element Plus is available as a component library, it's only used for toasts right now lol

Screenshots

Feed list

Feed

Entry

Run locally

Larafeed is built with Laravel Sail, so you can run it locally with Docker.

cp .env.example .env # and adjust the values
./vendor/bin/sail up -d
./vendor/bin/sail artisan migrate --seed
./vendor/bin/sail npm install
./vendor/bin/sail npm run dev

A quick login link is available on the login form, which will create a user and log you in.

License

Larafeed is licensed under the MIT license.