Skip to content

bocsir/letteRSS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LetteRSS - RSS Reader

Minimal RSS reader

The goal of this project is to create an RSS reader that doesn't feel as busy as other readers. Its built to show as little information at a time as possible.

Find it at https://letterss.net. If you want to see what its like without adding your feeds first, login with '[email protected]' and 'asdfgh'.

Tip:

If you want to add a blog that doesn't have a url that works, create one using https://fetchrss.com.

Curent Features

  • Auth uses JWT for access and refresh tokens
  • Users can add feeds by individual site link or with an .opml file
  • Feeds can be deleted and their names can be edited
  • Feeds can be filed into folders
  • Feeds can be sorted
  • Feeds can be read in-site or with an iframe to the original page

Future Features

  • Save read/unread feeds
  • Feed search
  • Change theme / font
  • Feed export
  • Mobile app

Run it locally

git clone https://github.com/bocsir/letteRSS

Install npm

cd letteRSS/frontend && npm install && cd ../server && npm install

Build frontend to be served

cd ../frontend && npm run build

Create database

  • use the sql queries in create_rss_db.sql

Create a .env file with the following, specifying the database name, user, pw, and secrets

DB_PORT=3306
DB_HOST=localhost
DB_NAME=
DB_USER=
USER_PW=
JWT_SECRET=
REFRESH_TOKEN_SECRET=

Start server

cd ../server && npm start

Some Pics

feed new feed article comic image

Libraries / Middleware

About

Minimal RSS reader for the web

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published