kindly-rss-reader
RSS Aggregator optimized for e-ink devices
File Explorer
Download Latest Version (.zip)- logo.xcf
- config.json
- Dockerfile.armv6
- Dockerfile.armv7
- Dockerfile.armv8
- Dockerfile.build
- Dockerfile.x86_64
- 1_dark.jpeg
- 1_light.jpeg
- 2_dark.jpeg
- 2_light.jpeg
- 3_dark.jpeg
- 3_light.jpeg
- logo_dark.png
- logo_light.png
- 20241230_article.sql
- 20241230_feed.sql
- migrations.sql
- get_config.rs
- mod.rs
- set_dark_theme.rs
- set_dont_invert_images.rs
- set_hide_article_header.rs
- set_toolbar_position_left.rs
- set_zoom.rs
- add_new_feed.rs
- add_new_feed_form.rs
- delete_feed.rs
- get_article.rs
- get_article_list.rs
- get_feed_list.rs
- mod.rs
- mod.rs
- not_found.rs
- error_handling_middleware.rs
- mod.rs
- article.rs
- feed.rs
- mod.rs
- parsed_feed.rs
- persisted_config.rs
- error.rs
- favicon_provider_impl.rs
- mod.rs
- atom_parser_impl.rs
- error.rs
- mod.rs
- rss_parser_impl.rs
- error.rs
- html_processor_impl.rs
- mod.rs
- error.rs
- image_processor_fs_impl.rs
- mod.rs
- error.rs
- mod.rs
- persisted_config_fs_impl.rs
- mod.rs
- feed_repository_impl.rs
- mod.rs
- feed_content_fs_impl.rs
- mod.rs
- mod.rs
- persisted_config_repository_impl.rs
- error.rs
- init.rs
- mod.rs
- error.rs
- feed_service_impl.rs
- mod.rs
- error.rs
- mod.rs
- persisted_config_service_impl.rs
- error.rs
- mod.rs
- template_service_impl.rs
- mod.rs
- article_list_item.rs
- error.rs
- mod.rs
- config.rs
- main.rs
- router.rs
- state.rs
- tracing.rs
- dark_theme.css
- font-awesome.min.css
- general.css
- light_theme.css
- fontawesome-webfont.eot
- fontawesome-webfont.svg
- fontawesome-webfont.ttf
- fontawesome-webfont.woff
- fontawesome-webfont.woff2
- FontAwesome.otf
- android-chrome-192x192.png
- apple-touch-icon.png
- favicon-16x16.png
- favicon-32x32.png
- favicon.ico
- android-chrome-192x192.png
- android-chrome-512x512.png
- apple-touch-icon.png
- bad_request.webp
- default_favicon.png
- favicon-16x16.png
- favicon-32x32.png
- favicon.ico
- internal_error.webp
- logo.webp
- not_found.webp
- site.webmanifest
- not_found.html
- Shuttle.toml
- article.html
- article_list.html
- common_head.html
- config.html
- dialog.html
- error.html
- feed_add.html
- feed_list.html
- toolbar.html
- .dockerignore
- .env
- .gitignore
- Cargo.lock
- Cargo.toml
- config.json
- LICENSE
- Makefile
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/nicoan/kindly-rss-reader
Downloads the entire project code from GitHub to your computer.
cd kindly-rss-reader
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run \
Runs the built image as an actual container.
docker build --tag kindly-rss .
Builds a runnable image based on the Dockerfile.
docker run --rm -p 3000:3000 kindly-rss
Runs the built image as an actual container.
**Note**: Do not modify this when running it in docker.
Type this command into your terminal and run it.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
3. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cargo run
Builds and then immediately runs the program.
If cargo build finishes without errors, it worked. The executable is created under target/.
Pulled directly from this repo's README.
4. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)