https://github.com/tanrax/RSSPAPER

Generate your own static RSS newspaper that you can embed on your device (PWA support)
https://github.com/tanrax/RSSPAPER

clojure rss-reader static-site-generator

Last synced: 10 days ago
JSON representation

Generate your own static RSS newspaper that you can embed on your device (PWA support)

• Host: GitHub
• URL: https://github.com/tanrax/RSSPAPER
• Owner: tanrax
• License: gpl-3.0
• Created: 2020-10-07T22:05:01.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-02-16T07:16:19.000Z (over 2 years ago)
• Last Synced: 2024-08-02T12:24:33.955Z (3 months ago)
• Topics: clojure, rss-reader, static-site-generator
• Language: CSS
• Homepage:
• Size: 8.73 MB
• Stars: 86
• Watchers: 4
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


  



Generate a static page with the latest news from your favorite feeds. Is it an RSS client? Yes, except that it generates an **HTML/PWA** that you can read or **install on your tablet or mobile** and to **update the news you must run it again**.

## Screenshots

### Light theme

![demo preview](media/demo.jpg)

### Sepia theme

![demo preview](media/sepia-mode.png)

### Dark theme

![demo preview](media/dark-mode.png)

## Demo



  👉 Generated weekly with Github Actions 👈



### PageSpeed Insights

![demo preview](media/pagespeed-insights.png)

## Run

1) Create a file `config.yaml` with the following content. You can also use `config.yaml.example` as a base config and change it to fit your needs.

``` yaml

# Change the title, it's for you. Maybe you see "My newspaper"?

title: RSSPAPER

# Options: light, dark, sepia or clojure 

theme: light

# Options: daily, weekly or all

edition: weekly

feeds:

  - https://programadorwebvalencia.com/feed/

  - https://republicaweb.es/feed/

```

2) Download the latest version of RSSpaper (`rsspaper-{version}-standalone.jar`).

https://github.com/tanrax/RSSPAPER/releases

(Both `jar` and `config.yaml` must be in the same directory)

3) Now you can execute.

```sh

java -jar rsspaper-{version}-standalone.jar

```

Great 🎉. You already have your 📰 own Static RSS Newspaper 📰.

That's it, now you just have to open `dist/index.html`.

## Dev

### Build

```sh

make build

```

### Run

```sh

lein run

```

### Make new theme

You can copy any theme hosted on `resources/themes`.

## TODO

- [ ] Create a binary with GraamVM 

- [ ] Generate feed

- [ ] Migrate from lein to clojure cli

- [ ] Add Podcast player

- [ ] Save cache offline

- [ ] Show preview of articles