https://github.com/fuyufjh/mior

mior - Merge into one RSS
https://github.com/fuyufjh/mior

rss rss-aggregator rust

Last synced: about 2 months ago
JSON representation

mior - Merge into one RSS

• Host: GitHub
• URL: https://github.com/fuyufjh/mior
• Owner: fuyufjh
• License: mit
• Created: 2022-05-23T03:24:04.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-08T17:44:43.000Z (almost 2 years ago)
• Last Synced: 2024-10-14T09:30:02.477Z (2 months ago)
• Topics: rss, rss-aggregator, rust
• Language: TypeScript
• Homepage: https://mior.ericfu.me/
• Size: 614 KB
• Stars: 37
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mior

_Merge into one RSS_

[![CI status](https://github.com/fuyufjh/mior/actions/workflows/ci.yml/badge.svg)](https://github.com/fuyufjh/mior/actions/workflows/ci.yml)

[![MIT License](https://img.shields.io/github/license/fuyufjh/mior?color=blue)](https://github.com/fuyufjh/mior/blob/main/LICENSE)

***mior*** is a lightweight web service to filter and merge multiple RSS feeds into one. It provides a pure web-based,

responsive user interface to manage the upstream feed sources. A merged RSS is provided to user to

fetch the merged results, which gathers all filtered items in upstream feeds.

![screenshot](assets/screenshot.png)

## Development Guide

### Frontend

The frontend is built with [Next.js](https://nextjs.org/) and [MUI](https://mui.com/zh/), and uses [Yarn](https://yarnpkg.com/) as its package manager.

We recommend installing Node.js with [fnm](https://github.com/Schniz/fnm) (Fast Node Manager).

```bash

curl -fsSL https://fnm.vercel.app/install | bash

```

Install Node.js and Yarn package manager.

```bash

cd frontend/

fnm install

npm install -g yarn

```

Install dependencies and start dev server.

```bash

yarn install

yarn dev

```

To build into static HTMLs:

```bash

yarn build

```

### Backend

The backend server is developed with [Rust](https://www.rust-lang.org/) language and [Rocket](https://rocket.rs/) web framework.

If this is your first time to build Rust projects, please install [rustup](https://rustup.rs/) and it will

set up all the environment automatically.

```bash

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

```

Additionally, openssl library is required by Rocket. 

```bash

# On macOS

brew install openssl

# On Debian/Ubuntu

sudo apt-get -y install pkg-config libssl-dev

```

Compile and start up the server:

```bash

cargo run

```

To build into binary in release mode:

```bash

cargo build --release

```

### Notes on Local Debug

By default, the backend server listens on http://localhost:8000 and the frontend (Next.js dev server) listens 

on http://localhost:3000, but the Next.js dev server has been configured to redirect API requests to the backend (see [next.config.js](next.config.js)). 

In practice, we recommend you to debug from the http://localhost:3000 in order to take advantage of the

[Fast Refresh](https://nextjs.org/docs/basic-features/fast-refresh) feature of Next.js.