Flus

Collect, organise, annotate and share links from around the Web.

---

Flus brings together feed aggregation, read-later lists and social bookmarking so you don’t have to juggle between multiple tools. It lets you:

• follow sources such as blogs, podcasts or video channels (RSS/Atom/JSON feeds) and collections shared on Flus, organised into thematic streams;
• read at your own pace with the “Journal”, which suggests links from the sources you follow, and with the “To read” and “Links read” lists;
• keep your links in collections to easily find them again, and annotate them with your thoughts and tags;
• share your links, collections and streams publicly on your profile so other people can follow you, or privately to collaborate with specific people.

It also comes with many other features:

• search and privacy: a powerful search engine, detection of tracking parameters in URLs…
• interoperability: sharing via Atom feeds and Mastodon, OPML import, full data export, an API for developers…
• tools: a web app you can install on your phone, a browser extension for Firefox, Firefox Mobile and Chrome (or a bookmarklet).

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 subscribing to the service. You can also host and operate Flus by yourself: it’s all documented.

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 and Elina Bufferne;
• the logo has been made by Clara Chambon;
• the font Raleway, by Matt McInerney, Pablo Impallari, Rodrigo Fuenzalida
• the icons comes from Lucide and Simple Icons;
• the illustrations are from the unDraw project, by Katerina Limpitsouni;
• default cards illustrations comes from Pattern Monster.

It’s also based on other projects:

• ClearURLs rules to detect and remove trackers from URLs;
• esbuild, a build tool for JavaScript;
• FakerPHP to generate fake data during tests;
• Minz, a small and personal PHP framework;
• 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. Please read the CONTRIBUTING file first.

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. REST API guide
6. Working with Docker
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