https://github.com/sanpii/oxfeed

A feed reader write in rust
https://github.com/sanpii/oxfeed

Last synced: 2 months ago
JSON representation

A feed reader write in rust

• Host: GitHub
• URL: https://github.com/sanpii/oxfeed
• Owner: sanpii
• License: mit
• Created: 2020-12-02T21:54:23.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-16T10:04:50.000Z (4 months ago)
• Last Synced: 2024-09-16T11:42:55.982Z (4 months ago)
• Language: Rust
• Homepage:
• Size: 1.09 MB
• Stars: 12
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-yew - Oxfeed - A feed reader written in Rust with a Yew frontend. (Projects)

README

        
# OxFeed

[![Github actions](https://github.com/sanpii/oxfeed/workflows/.github/workflows/ci.yml/badge.svg)](https://github.com/sanpii/oxfeed/actions?query=workflow%3A.github%2Fworkflows%2Fci.yml)

[![pipeline status](https://gitlab.com/sanpi/oxfeed/badges/main/pipeline.svg)](https://gitlab.com/sanpi/oxfeed/-/commits/main)

Feed reader.

![Screenshot](screenshot.png)

## Demo

- email: `demo`

- password: `demo`

This is a read-only demo: you can only read/unread and fav/unfav item.

## Compilation

```

make

```

## Installation

Create a new PostgreSQL database:

```

createdb oxfeed

psql -f api/sql/structure.sql oxfeed

```

Here an example of systemd service:

```

[Unit]

Description=oxfeed

After=network.target

After=postgresql.target

Requires=postgresql.service

[Service]

ExecStart=/home/git/public_repositories/oxfeed/current/target/release/oxfeed-api

WorkingDirectory=/home/git/public_repositories/oxfeed/current

Restart=on-failure

RestartSec=10s

Environment="LISTEN_IP=127.0.0.1"

Environment="LISTEN_PORT=8003"

Environment="DATABASE_URL=postgresql://localhost/oxfeed"

Environment="SECRET=change_me"

Environment="RUST_LOG=warn"

Environment="CACHE_DIR=/var/cache/oxfeed"

```