Skip to content

Latest commit

 

History

History
74 lines (55 loc) · 2.25 KB

README.md

File metadata and controls

74 lines (55 loc) · 2.25 KB
Raw

qualifyrss

License dependency status Rust RSS Atom Beta Docker

Overview

qualifyrss is a simple HTTP server that takes a Base64 encoded URL, fetches the RSS feed from the URL, qualifies its links by using ArticleScraper (readability), and returns a modified RSS feed with (hopefully) full content. It is built using Rust.

Installation

Prerequisites

Building from Source

  1. Clone the repository:

    git clone https://github.com/your-username/qualifyrss.git
cd qualifyrss

  2. Build the project:

    cargo build --release

Usage

Running the Server

  1. Run the server:

    cargo run --release -- -p <PORT>

    or

    ./target/release/qualifyrss -p <PORT>

    Replace <PORT> with the desired port number or ignore the -p parameter (default is 8080).

  2. The server will start and listen for incoming HTTP connections on the specified port.

Making Requests

To make a request to the server, you need to send an HTTP GET request with a Base64 encoded URL as the path.

Example:

curl http://127.0.0.1:<PORT>/<Base64_encoded_URL>

Replace with the port number the server is running on and <Base64_encoded_URL> with the Base64 encoded URL of the RSS feed you want to process.

Example

  1. Encode a URL in Base64:
echo -n "https://example.com/rss" | base64
# Output: aHR0cHM6Ly9leGFtcGxlLmNvbS9yc3M=
  1. Make a request to the server:
curl http://127.0.0.1:<PORT>/aHR0cHM6Ly9leGFtcGxlLmNvbS9yc3M=

License

This project is licensed under the MIT License.