Read your Internet article flow in one place with complete peace of mind and freedom.
Run the following command:
$ go get -v github.com/ncarlier/readflow
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 -d --name=readflow ncarlier/readflow:edge
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.
readflow -h to display all parameters and related environment variables.
You can access Web UI on http://localhost:8080/ui
The documentation can be found here: https://about.readflow.app/docs
You can explore the server API using GraphiQL endpoint: http://localhost:8080/graphiql
To be able to build the project you will need to:
$ git submodule init $ git submodule update
Then you can build the project using make:
make help to see other possibilities.
These amazing people have sponsored this project:
Readflow artworks except the logo are under the Licence Creative Commons Attribution-NonCommercial-NoDerivatives 4.0. Attribution to Maxime Belloche
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/>