NGI Project: Funkwhale

[odilf]

Short Summary

Funkwhale is a free, decentralized and open-source audio streaming and sharing platform, built on top of the ActivityPub protocol. It enables users to create communities of interest around music and audio content in general, listen to their private music library or distribute their own productions on the network.

NLnet page(s)

• https://nlnet.nl/project/Funkwhale/
• https://nlnet.nl/project/FunkWhale-Federation/
• https://nlnet.nl/project/Funkwhale-AP/

Website

https://www.funkwhale.audio/

Source repository

• https://dev.funkwhale.audio/funkwhale/funkwhale
  • Language/Framework: Python (backend) + Typescript/Vue (frontend)
  • Dependency management: Poetry (backend) + Yarn (frontend)
  • Nix development environment:

Documentation

• Usage Examples:
  • https://docs.funkwhale.audio/user/index.html
• Build from source/Development:
  • https://docs.funkwhale.audio/developer/index.html
• Other:
  • Moderator guide: https://docs.funkwhale.audio/moderator/index.html
  • Admin guide: https://docs.funkwhale.audio/administrator/index.html
  • Forum: https://forum.funkwhale.audio/

Artefacts

• Frontend:
  • docs: https://dev.funkwhale.audio/funkwhale/funkwhale/-/tree/develop/front/ui-docs?ref_type=heads
  • tests: https://dev.funkwhale.audio/funkwhale/funkwhale/-/tree/develop/front/test?ref_type=heads
  • e2e tests: https://dev.funkwhale.audio/funkwhale/funkwhale/-/tree/develop/front/cypress?ref_type=heads
• Backend:
  • tests: https://dev.funkwhale.audio/funkwhale/funkwhale/-/tree/develop/api/tests?ref_type=heads

Nixpkgs/NixOS

• Packages:
  • N/A
• Services:
  • N/A

Extra Information

• Previous packaging attempts: https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+funkwhale+is%3Aclosed

Tasks

Add a sub-issue using the appropriate GitHub template for each of the following tasks:

• Triage project
• Implement project metadata

Next, depending on the project deliverable, open sub-issues for the following tasks:

• Implement NixOS program module
• Implement NixOS service module