[BOUNTY] Implement affine knowledge base as Fairdrive dApp

[crtahlin]

Motivation / background / user story:

Knowledge management is an important part of current society, either for students, knowledge workers or just anyone trying to organize their work, activities and life.

As the area is evolving, different tools are taking the lead. For the users, it is important that the data is kept under their control, private and interoperable with other tools if they choose to switch.

Fairdrive allows a space to store the data in a decentralized personal cloud and share it with other dApps. Therefore, this bounty is about implementing Fairdrive storage support for a knowledge management application.

AFFiNE is a knowledge base exploring the frontiers of how knowledge management could be done and putting privacy as a priority.

Tasks

• Familiarize with the repo containing Fairdrive: https://github.com/fairDataSociety/fairdrive-theapp
• Familiarize with the repo of AFFiNE: https://github.com/toeverything/AFFiNE
• Create a public repo on Github that contains your code
• Modify AFFiNE code so that the use case is possible:
  • AFFiNE runs as a dApp from Swarm decentralized storage
  • user can load/open existing dApp data from Fairdrive (its underlying storage)
  • user can create new data, edit existing data, save data to Fairdrive
  • user can use all the features of AFFiNE in the use case (e.g. text editing, Kanban boards, rearranging notes, ...)
  • user can open Fairdrive and see the data directly in Fairdrive
  • support concurrent work features (CRDT features, as in Yjs support for Slate)
  • supports Blossom browser extension for user authentication and access to storage
  • Deploy working dApp on Swarm and provide reference to it
  • Register the dApp on Fair Portal: https://fairdrive.fairdatasociety.org/apps/fportal/
  • Create demo recording showing the app features, connection to Fairdrive and support for concurrent work (CRDT features)

Approving criteria

• A new public repo is opened with open source code and a link to the repo is in the Gitcoin issue.
• Include Readme file with instructions on how to use the app and general documentation
• Code must be documented
• Use open source license Apache 2.0
• All tasks completed
• Use case is covered
• A working dApp available and deployed on Swarm storage
• Data must be appropriately synced to Fairdrive/FairOS if at least 2 users are working on same document, without data loss occurring (or one user working from 2 different instances).
• A demo recording of the use case is provided

Timeline

Estimated time needed for this bounty is around 3 weeks.

Deadline: 4 calendar weeks after approval.

Compensation: In BZZ tokens in amount of 5000 DAI at the date of payment (as of the price of BZZ / DAI on the day of the payout as determined by Fair Data Society).

Bounty process

• One team will be selected and approved to work on the project.
• Upon completion, the bounty will be awarded to the chosen team, if the approving criteria is met.
• If the approving criteria is not met, another team will be selected and approved. Consequentially the deadline will be extended.
• If no project matches all the approving criteria, no bounty will be awarded.

References

References that might be helpful in completing the bounty.

Use the Fair Data Society Discord for more information and support.

Mind the Fair Data Society Principles in your tasks.