MikePadge / readflow

Read the Internet with complete peace of mind and freedom.

readflow

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

Features

• Read articles from anywhere in one place.
• Save articles for offline reading.
• Save articles to external services (Keeper, Wallabag, Webhooks...).
• Create categories and classify new articles automatically thanks to a customizable rule engine.
• Receive notifications when new articles are to be read.
• Good user experience on mobile devices.
• No tracking and no publicity.

Installation

Run the following command:

$ go get -v github.com/ncarlier/readflow

Or download the binary regarding your architecture:

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

Or use Docker:

$ docker run -d --name=readflow ncarlier/readflow

Configuration

Readflow can be configured by using command line parameters or by setting environment variables.

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

All configuration variables are described in etc/default/readflow.env file.

UI

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

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:

---

License

Readflow is provided under the MIT License.

The MIT License (MIT)
Copyright (c) 2019 Nicolas Carlier
 
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---