Flus

Aggregate, save and share links from all over the Web.

Flus brings together news feed aggregation and social bookmarking in a modern way. It is designed as a simple, yet complete tool for organising the links you gather around the Web. It comes with four main features:

• the feeds aggregation (RSS and Atom) to follow any website, podcast or video channel in one place;
• the bookmarks and collections to save your favourites articles for later and to organise them;
• the news to keep control over your newsfeed;
• the profile to share links with others.

You can try Flus for free at demo.flus.fr.

It’s free/libre software (politically speaking) while being supported by a micro-enterprise to ensure its viability. The main service is available to French people at flus.fr. You can help to fund the development by taking a subscription to the service.

Flus is licensed under AGPL 3.

Credits and dependencies

Flus is built upon the work of many other people:

• the user experience and interface have been designed with the help of Maiwann;
• the logo has been made by Clara Chambon;
• the font Comfortaa, by Johan Aakerlund;
• the font Open Sans, by Steve Matteson;
• the icons are from the Clarity project;
• the illustrations are from the unDraw project, by Katerina Limpitsouni;
• default cards illustrations are from SVGBackgrounds.

It’s also based on other projects:

• ClearURLs rules to detect and remove trackers from URLs;
• FakerPHP to generate fake data during tests;
• Minz, a small and personal PHP framework;
• Parcel, a build tool for JavaScript;
• Parsedown to render Markdown;
• PHP_CodeSniffer, Eslint and Stylelint to enforce PHP, JavaScript and CSS coding standards;
• PHPMailer to send emails with PHP;
• PHPUnit, a testing framework for PHP;
• Stimulus, a modest JavaScript framework;
• Turbo to bring speed of single-page applications to Flus.

How to contribute?

I sincerely appreciate if you want to contribute. Here’s a few things you can do:

• taking a subscription at flus.fr (French);
• reporting bugs or make feature requests in issues;
• writing blog posts to speak about the project.

I don’t accept Pull Requests on this project. A code contribution requires a lot of time to review, to comment and to maintain. Even the smallest one can require hours of my time. Also, code isn’t where I need help.

If you have any question, feel free to send me a message.

Administrator guide

This guide is intended to people who want to install Flus on their own server.

1. Deploy in production
2. How to update Flus
3. How to improve performance
4. Enable experimental features
5. CHANGELOG

You also might be interested by the following:

1. Technical stack overview
2. How is the CLI working

Developer guide

If you plan to take a look at the code, these guides should be helpful to understand how Flus is developed.

1. Technical stack overview
2. Setup the development environment
3. How to update Flus
4. Getting started
5. Working with Docker
6. How are the users’ errors managed
7. How is the CLI working
8. How is the localization managed
9. How are the assets bundled
10. How to run the test suite

Maintainer guide

This guide is intended to myself, as a maintainer of Flus.

1. How to release a new version