petersaints
commented
4 years ago Currently this is mostly an academic project that is part of my PhD about create the tools needed to develop applications that run and spread their user interface across multiple co-located devices.
This project here can't run on its own. It depends on a series of other components that form the YanuX Framework:
- YanuX Auth is responsible for user authentication and authorization: https://github.com/YanuX-Framework/YanuX-Auth
- YanuX Broker is responsible for the interconnection between the frameworks multiple agents: https://github.com/YanuX-Framework/YanuX-Broker
- YanuX Coordinator is a TypeScript/JavaScript library that can be incorporated into web/hybrid apps and that facilitates the communication with the YanuX Broker + a series of other useful tools for this kind of applications: https://github.com/YanuX-Framework/YanuX-Coordinator
- YanuX Desktop Client which a Node.js command line interface application that makes a BLE-eanbled laptop/desktop emit an iBeacon signal while it scans for other iBeacon signals in order to detect the presence of other devices while it makes itself be heard by other devices also scanning for iBeacon signals: https://github.com/YanuX-Framework/YanuX-DesktopClient
- YanuX Scavenger which is an Android application where I have made a series of experiments but that in practice is the mobile counterpart to the YanuX Desktop Client: https://github.com/YanuX-Framework/YanuX-Scavenger
All this said, I don't currently have any well written documentation about how to use all these components together. In fact, writing some good tutorials and developer focused documentation is something that I intend to do in the future once I'm able to get a few more core features into the framework.
However, if you are curious about this application in particular (YanuX YouTube Viewer) you can read all about it on this paper that I have published and presented a few months ago: https://dl.acm.org/doi/abs/10.1145/3360774.3360832
For the time being, I'll just leave this issue open as a reminder.
How to use?