Skip to content

Latest commit

 

History

History
354 lines (254 loc) · 13.9 KB

README.md

File metadata and controls

354 lines (254 loc) · 13.9 KB
Raw

TiBillet - Federated tools for cooperative networks

Note

TLDR; A suite of free applications for managing your social and solidarity venue : Cash register, membership, ticketing, cashless, time currency, order taking and room management. The current git repository is one of the building blocks of the TiBillet ecosystem: Fedow To read more and talk with us : https://tibillet.org

dashboard demo image

EN : Introduction

TiBillet is a FLOSS solution for payment, associative membership, online booking and ticketing, time and local currency management, festival cashless and order management for refreshment stands and catering facilities.

The general idea is to broaden the scope of a membership and/or cashless card already in circulation at many venues and festivals, to create a cooperative network.

The platform aims to encourage the circulation of audiences and cooperation between the various players in an area, such as third-party venues, associations, festivals, artists, craftsmen and open-source software developers.

Users have access to an NFC card valid throughout the TiBillet network, with no subscription or top-up fees, enabling them to manage and associate memberships, subscriptions, time currencies, local and/or free and federated to several venues.

Last but not least, TiBillet is an open-source software package developed by Code Commun Cooperative (https://codecommun.coop).

When you use TiBillet, you become part of a social economy network that supports you from A to Z.

TiBillet is made by the Code Commun Cooperative

FR : Introduction

Réseau événementiel et coopératif.

TiBillet est un ensemble d'outils libres qui comprend une caisse enregistreuse, un système de paiement sans contact Zéro Espèce ( Cashless ), de gestion d'évènements, de gestion de salles de restauration, d'adhésion et d'engagement associatif, de boutique et de reservation en ligne … mais pas uniquement !

C'est aussi un outil de mise en réseau et de gestion d'une carte cashless locale et commune à plusieurs lieux.

L’idée de TiBillet est de se réapproprier des outils qui n’existent tout simplement pas en libre, et de les mutualiser pour en faire un réseau de musiciens, de lieux et pourquoi pas une monnaie locale dédiée, à la culture, aux associations, aux tiers-lieux, etc...

La richesse de TiBillet, c’est de chercher à créer des zones d’échange, de créer une économie circulaire, sociale et solidaire, décentralisée et non spéculative à l'échelle d'un territoire.

TiBillet est en période de BETA et en expérimentation sur plusieurs lieux sur l'ile de la Réunion. Venez nous voir au Bisik, à la Raffinerie, et au Manapany Festival !

TiBillet/FEDOW : FEDerated and Open Wallet.

Warning

Work in progress. ALPHA RELEASE. Go talk with us !

The current git repository is one of the building blocks of the TiBillet ecosystem: Fedow It contains the the federation engine.

The engines are :

  • Lespass: ticketing, membership and landing page engines.

  • LaBoutik: Cash register, cashless system with RFID / NFC chip and order-taking system.

  • Fedow : Federated and open wallet, the federation engine. A blockchain to share membership assets, local currencies and time for several Lespass and LaBoutik instances.

Presentation (EN)

Free and open source software for cashless payment, creation and management of a grouping of local, complementary and citizen currencies (MLCC) within a federated network.

Fedow has been designed to connect different TiBillet/LaBoutik point-of-sale servers for a place federation. it enables the use of dematerialised wallets (cashless ), in various community, cooperative and/or commercial venues that can be used directly on the cash register.

They can share the NFC / RFID / QRCODE cashless payment and membership cards of their respective users in a open and secure network.

Fedow can also be used on its own via a python client or an HTTP API.

It can be used to create a festival cashless system, a loyalty system, a local currency, subscriptions and memberships, and a badge reader that keeps track of time used for space location, a time clock that tracks time spent, all for one or more venues.

Finally, Fedow incorporates the principles of melting fiat currencies into a transparent, non-speculative and energy-efficient blockchain.

You can find out more on our french blog :

https://codecommun.coop/blog/federation-part5-fedow

Présentation (FR)

Outil FLOSS de création et de gestion d'un groupement* de monnaies locales, complémentaire et citoyenne (MLCC) au sein d'un réseau fédéré, Fedow a été conçu pour connecter différents serveurs de points de vente TiBillet afin qu'ils puissent partager les cartes de leurs utilisateurs respectifs.

S'intégrant aux outils TiBillet il permet l'utilisation de portefeuilles dématérialisés ( cashless ), dans différents lieux associatifs, coopératifs et/ou commerciaux directement utilisable sur la caisse enregistreuse.

Fedow peut aussi être utilisé seul via un client python ou une API HTTP.

Il peut être utilisé pour créer un cashless de festival, un système de fidélité, une monnaie locale, des abonnements et adhésions, une badgeuse qui comptabilise le temps utilisé pour une location d'espace, le tout pour un ou plusieurs lieux. Avec des cartes NFC / RFID et bientôt avec un simple scan de QRCode.

Enfin, Fedow intègre des principes de monnaie fondantes dans une chaine de blocs par preuve d'autorité, transparente, non spéculative et non énergivore.

Vous pouvez trouver plus d'informations sur notre blog :

https://codecommun.coop/blog/federation-part5-fedow

Documentation :

EN : [https://tibillet.org] FR : [https://tibillet.org/fr]

Features and roadmap

  • Handshake with TiBillet/LaBoutik
  • Create place
  • Create link (or not) with another place
  • Hash validation
  • Proof of authority (PoA) consensus
  • HTTP Signature for transaction auth (rsa asymetrical algorithm)
  • Authority delegation for wallet ( user -> place )
  • Create fiat asset (ex : euro)
  • Create no fiat asset (ex : ticket resto, time currency)
  • Create subscription asset (ex : membership)
  • Create time asset (ex : time spent in a place)
  • Primary Card authentifier (NFC/RFID)
  • Create a new user and new wallet with email or FirstTag of a NFC/RFID card
  • Double authentification
  • Transaction Place wallet <-> User wallet
  • Transaction Fedow primary wallet (Stripe Connect) <-> User wallet
  • Transaction Fedow primary wallet (Stripe Connect) <-> Place wallet
  • Transaction User wallet <-> User wallet via QRCode (need double auth)
  • Transaction Place wallet <-> Place wallet (Compensation algorithm)
  • Webhook
  • Wallet on NFC Card (Cashless)
  • Wallet on QRCode (soon, need double auth)
  • Refund wallet
  • Void card (disconnect card from wallet)
  • Scan NFC Card for payment
  • Scan NFC Card for subscription
  • Scan NFC Card for refill wallet

Server

Install

For production :

See documentation on https://tibillet.org/docs/install/docker_install

For dev/test :

For any help, don't hesitate to talk with us on Discord or Rocket Chat

# Clone the repo :
git clone https://github.com/TiBillet/Fedow && cd Fedow
# Set your secret :
cp env_example .env && nano .env
# Launch the server :
docker compose up -d
# Logs :
docker compose logs -f 
# Dashboard :
http://localhost:8442/

Usage

Some actions can only be performed on the server itself. The creation of a new federation, a new location and new assets are all under the control of the network animator.

# Use compose or poetry command like that :
# Inside the poetry shell 
python manage.py federations [OPTIONS]
# Outsite of docker 
docker compose exec fedow poetry run python manage.py federations [OPTIONS]

Create and manage Federations

A federation brings together assets from different locations so that they can be seen by one another. Example: a common subscription to access a set of different co-working spaces, a cashless payment system shared between several music festivals or associations, a shareable time currency, etc...

Fedow use the command-line tool of Django for managing federations. It provides several options to add or remove assets and places from a federation, as well as listing all assets in the database.

Options

  • --create: Create a federation. Requires --name.
  • --add_asset: Add an asset to a federation. Requires --fed_uuid and --asset_uuid.
  • --remove_asset: Remove an asset from a federation. Requires --fed_uuid and --asset_uuid.
  • --add_place: Add a place to a federation. Requires --fed_uuid and --place_uuid.
  • --remove_place: Remove a place from a federation. Requires --fed_uuid and --place_uuid.
  • --fed_uuid: The UUID of the federation.
  • --asset_uuid: The UUID of the asset.
  • --place_uuid: The UUID of the place.
  • --list: List all assets and federations in the database.

Examples

# List all assets and federation in the database:
python manage.py federations --list
# Create a new federation:
python manage.py federations --create --name "My new federation"
# Add an asset to a federation:
python manage.py federations --add_asset --fed_uuid <FEDERATION_UUID> --asset_uuid <ASSET_UUID>
# Remove an asset from a federation:
python manage.py federations --remove_asset --fed_uuid <FEDERATION_UUID> --asset_uuid <ASSET_UUID>
# Add a place to a federation:
python manage.py federations --add_place --fed_uuid <FEDERATION_UUID> --place_uuid <PLACE_UUID>
# Remove a place from a federation:
python manage.py federations --remove_place --fed_uuid <FEDERATION_UUID> --place_uuid <PLACE_UUID>

Create and manage Places

python manage.py places [OPTIONS]

A place is a location that can be part of a federation. It can be a co-working space, a music festival, a shop, a associative bar...

After creating the place, Fedow gives you a key to make a handshake with the TiBillet/LaBoutik engine.

Enter this key in your admin interface -> federation.

The handshake will automatically link the assets and NFC cards entered in the TiBillet/LaBoutik engine.

Congratulations, these cards will be readable throughout the federation network!

You can then link the location assets created by the TiBillet/Fedow handshake to a federation to share a local currency, a time currency or subscriptions throughout the federation.

Options

  • --create: Create a new place. Requires --name and --email. Optional --description and --test.
  • --list: List all places in the database.
  • --name: Name of the place.
  • --email: Email of the admin.
  • --description: Description of the place.

Examples

# Create a place:
python manage.py places --create --name <PLACE_NAME> --email <ADMIN_EMAIL> --description <DESCRIPTION>
# List all places in the database:
python manage.py places --list

Create and manage Assets

If you already have a cash register server, cashless and membership TiBillet/LaBoutik, asset creation is done automatically during the handshake. Simply enter the key given when creating the location in your administration interface.

Please note that once the locations and assets have been configured, you must also validate them on the TiBillet/LaBoutik side.

Usage

python manage.py assets [OPTIONS]

Options

  • --list: List all assets in the database.
  • --create: Create an asset. Requires --name, --currency_code, --category, and either --place_origin or --wallet_origin.
  • --place_origin: UUID of the place origin.
  • --wallet_origin: UUID of the wallet origin.
  • --currency_code: Currency code (max 3 characters).
  • --name: Currency name.
  • --category: Category of the asset. The choices are:
    • TLF for token local fiat currency
    • TNF for token local non fiat currency (gift card, voucher for a meal, etc ..)
    • SUB for subscription or membership.
    • TIM for time tracking, time currency, etc ...
    • BDG For badge reader. Track passage of a card.

Examples

# Create an asset:
python manage.py assets --create --name <ASSET_NAME> --currency_code <CURRENCY_CODE> --category <CATEGORY> --place_origin <PLACE_ORIGIN_UUID>
# List all assets in the database:
python manage.py assets --list

Congratulations, you've created a federation of places around a local, complementary and citizen currency!

Python lib

coming soon

HTTP API

coming soon

Test

poetry shell
coverage run --source='.' manage.py test
coverage report
# or 
coverage html

Made by, with and for :

Special thanks to :

  • Jetbrain supports non-commercial open source projects.

Contact :