RSSPAPER/README.md

93 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2021-07-06 16:20:41 -04:00
<h1 align="center">
2021-07-20 15:49:39 -04:00
<img alt="RSSpaper logo" src="media/newsreader-banner.png">
2021-07-06 16:20:41 -04:00
</h1>
2021-09-09 09:42:24 -04:00
2021-09-09 09:44:33 -04:00
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
2021-10-02 05:21:48 -04:00
### Light theme
2021-09-09 09:44:33 -04:00
![demo preview](media/demo.jpg)
2021-10-04 11:27:13 -04:00
### Sepia theme
![demo preview](media/sepia-mode.png)
2021-10-02 05:21:48 -04:00
### Dark theme
![demo preview](media/dark-mode.png)
2021-09-09 09:42:24 -04:00
## Demo
2021-07-06 12:02:59 -04:00
<p align="center">
2021-10-07 07:56:36 -04:00
<a href="https://tanrax.github.io/demo-RSSPAPER/">👉 Generated weekly with Github Actions 👈</a>
2021-07-06 16:29:09 -04:00
</p>
2020-11-03 17:57:47 -05:00
2021-09-09 09:43:09 -04:00
### PageSpeed Insights
2021-09-09 09:42:24 -04:00
![demo preview](media/pagespeed-insights.png)
2021-07-19 18:32:46 -04:00
2021-07-06 16:26:44 -04:00
## Run
2021-07-19 18:24:32 -04:00
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.
2021-07-06 16:26:44 -04:00
``` yaml
2021-07-19 18:26:05 -04:00
# Change the title, it's for you. Maybe you see "My newspaper"?
title: RSSPAPER
2021-07-06 16:26:44 -04:00
2021-10-25 12:38:01 -04:00
# Options: light, dark, sepia or clojure
2021-07-06 16:26:44 -04:00
theme: light
# Options: daily, weekly or all
edition: weekly
feeds:
- https://programadorwebvalencia.com/feed/
- https://republicaweb.es/feed/
```
2021-07-19 18:24:32 -04:00
2) Download the latest version of RSSpaper (`rsspaper-{version}-standalone.jar`).
2021-07-06 16:26:44 -04:00
2021-07-19 18:32:46 -04:00
https://github.com/tanrax/RSSPAPER/releases
2021-07-06 16:26:44 -04:00
2021-07-30 06:06:54 -04:00
(Both `jar` and `config.yaml` must be in the same directory)
2021-07-06 16:26:44 -04:00
2021-07-19 18:24:32 -04:00
3) Now you can execute.
2020-11-03 17:57:47 -05:00
2020-11-04 01:25:21 -05:00
```sh
2021-07-06 16:26:44 -04:00
java -jar rsspaper-{version}-standalone.jar
2020-11-04 01:25:21 -05:00
```
2020-11-03 17:57:47 -05:00
2021-07-06 19:07:59 -04:00
Great 🎉. You already have your 📰 own Static RSS Newspaper 📰.
2021-07-06 16:26:44 -04:00
That's it, now you just have to open `dist/index.html`.
2021-10-16 03:07:11 -04:00
## Dev
### Build
```sh
make build
```
### Run
```sh
lein run
```
### Make new theme
2021-10-25 12:38:01 -04:00
You can copy any theme hosted on `resources/themes`.
2021-12-25 06:19:51 -05:00
## TODO
2021-12-25 06:20:33 -05:00
- [ ] Create a binary with GraamVM
- [ ] Generate feed
- [ ] Migrate from lein to clojure cli
- [ ] Add Podcast player
- [ ] Save cache offline
- [ ] Show preview of articles