Readflow logo

Readflow

  •  0 ratings
In category: Miscellaneous

About Readflow

Lightweight news reader with modern interface and features: full-text search, automatic categorization, archiving, offline support, notifications...

  •   573  
  •   0  
  •   0  
  •   0  
Github stats:
  •  Commits: 534  
  •   278  
  •   21  
  •  Latest commit: Jan 22, 2023  

Deploy this app to Linode with a free $100 credit!

Languages/Platforms/Technologies:
Lincenses:

More about Readflow

readflow

Build Status Go Report Card Docker pulls

Read your Internet article flow in one place with complete peace of mind and freedom.

Logo

Features

  • Read articles from anywhere in one place.
  • Save articles for offline reading or locally on you disk in the format you want (HTML, EPUB, ZIP, ...).
  • Create categories and classify new articles.
  • Customize article integration with a scripting engine.
  • Link with external services thanks to incoming and outgoing webhooks (RSS, Keeper, Pocket, Shaarli, Wallabag, S3 bucket, and more...).
  • Receive notifications when new articles are available.
  • Enjoy the same user experience on mobile as on desktop thanks to Progressive Web App support.
  • And all this without ads and trackers.

Installation

Run the following command:

$ go install -v github.com/ncarlier/readflow@latest

Or download the binary regarding your architecture:

$ curl -sf https://gobinaries.com/ncarlier/readflow | sh
$ # or
$ curl -s https://raw.githubusercontent.com/ncarlier/readflow/master/install.sh | bash

Or use Docker:

$ docker run -it --rm \
    -p 8080:8080 \
    -e READFLOW_DB=<YOUR POSTGERSQL CONNECTION STRING> \
    ncarlier/readflow:edge

Configuration

Readflow configuration is a TOML file that you can specify using the --config command line parameter or by setting the READFLOW_CONFIG environment variable.

You can initialize a configuration file example by using the --init-config command line parameter.

A configuration file example can be found here.

Type readflow -h to display all parameters and related environment variables.

UI

You can access Web UI on http://localhost:8080/ui

Screenshot

Documentation

The documentation can be found here: https://about.readflow.app/docs

GraphQL API

You can explore the server API using GraphiQL endpoint: http://localhost:8080/graphiql

Development

To be able to build the project you will need to:

  • Install makefiles external helpers:
    $ git submodule init
    $ git submodule update

Then you can build the project using make:

$ make

Type make help to see other possibilities.

Bakers

These amazing people have sponsored this project:

Code Lutin

Donate


Licenses

Readflow artworks except the logo are under the Licence Creative Commons Attribution-NonCommercial-NoDerivatives 4.0. Attribution to Maxime Belloche

Avatar atrworks are under the License Creative Commons Attribution 4.0. Attribution to David Revoy

Readflow is provided under the GNU Affero General Public License Version 3 (AGPLv3).

Readflow is a personal news reader service.

Copyright (C) 2021 Nicolas Carlier

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>

Comments (0)

Please login to join the discussion on this project.

Readflow Reviews (0)

Overall Rating

None

based on 0 ratings

Please login to review this project.

No reviews for this project yet.

↑ back to top

pCloud Lifetime

Popular Projects

FluxBB

in Social Networks and Forums
 33k    0    0    0  

Nextcloud

in File Transfer & Synchronization
 21k    1    1    0  

Libreddit

in Social Networks and Forums
 7k    0    1    0  

Dashboard

in Personal Dashboards
 6k    0    0    0  

Audiobookshelf

in Audio Streaming
 6k    0    1    0  

CasaOS

in Self-hosting Solutions
 5k    0    0    0  

Mediagoblin

in Photo and Video Galleries
 4k    0    0    0  

Most Discussed

Nextcloud

in File Transfer & Synchronization
 21k    1    1    0  

Tube Archivist

in Automation
 3k    0    1    0  

OneDev

in Project Management
 2k    0    0    0  

iodine

in Proxy
 2k    0    0    0  

Alf.io

in Booking and Scheduling
 2k    0    0    0  

sysPass

in Password Managers
 1k    0    0    0  

Misskey

in Social Networks and Forums
 2k    0    0    0  
Linux VPS from $11/yr.
RackNerd VPS for $11.38/mo

Top Rated Projects

Gitea

 1 rating
in Project Management

Bagisto

 1 rating
in E-commerce

LinkAce

 1 rating
in Bookmarks and Link Sharing

Pydio

 1 rating
in File Transfer & Synchronization

Audiobookshelf

 1 rating
in Audio Streaming

Nextcloud

 1 rating
in File Transfer & Synchronization

Seafile

 1 rating
in File Transfer & Synchronization

Categories

You May Also Be Interested In

Flox logo
Flox cover

Flox

Self hosted movie, TV series and anime watch list with a 3-…

Octave Online logo
Octave Online cover

Octave Online

Infrastracture behind a web UI for GNU Octave, the libre al…

IconCaptcha logo
IconCaptcha cover

IconCaptcha

IconCaptcha is a self-hosted, fast, simple and user-friendl…