Giter Club home page Giter Club logo

flus's Introduction

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.

Screenshot of the news page with 3 links

Credits and dependencies

Flus is built upon the work of many other people:

It’s also based on other projects:

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.