README 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. # -*- mode: org; org-html-head-include-default-style: nil; org-html-postamble: nil; -*-
  2. #+OPTIONS: toc:nil
  3. * Tau
  4. An alternative front-end to various streaming sites. The aim of Tau is to free you from the world of ad-ridden streaming sites full of vendor lock-ins by providing you with a minimal interface to enjoy your favorite content. It currently supports the following platforms:
  5. - YouTube
  6. - SoundCloud
  7. - media.ccc.de
  8. - PeerTube
  9. - Bandcamp
  10. To retrieve the data, it leverages the excellent [[https://github.com/TeamNewPipe/NewPipeExtractor][NewPipe Extractor]] library that powers the popular [[https://github.com/TeamNewPipe/NewPipe][NewPipe]] Android app. Tau exposes the extracted data over a REST API that is consumed by a local re-frame SPA.
  11. The ultimate goal behind Tau is to replicate the Newpipe experience on the web, so that it's accessible to those that don't use an Android device.
  12. ** Installation
  13. The easiest way to set up Tau's dependencies is via the [[https://guix.gnu.org/][GNU Guix]] package manager. Simply invoke what follows:
  14. #+begin_src sh
  15. cd /path/to/tau
  16. guix shell
  17. #+end_src
  18. To run the application, first compile the downloader ahead-of-time.
  19. #+begin_src sh
  20. clojure -M -e "(compile 'tau.downloader-impl)"
  21. #+end_src
  22. Fetch the front-end dependencies and build the front-end assets.
  23. #+begin_src sh
  24. npm i
  25. npm run build
  26. #+end_src
  27. Then, compile the front-end.
  28. #+begin_src sh
  29. clojure -M:frontend compile tau
  30. #+end_src
  31. You can now start a local server that listens on port 3000 by running the following:
  32. #+begin_src sh
  33. clojure -M:run
  34. #+end_src
  35. Access the front-end in your browser at =http://localhost:3000=.
  36. ** Screenshots
  37. https://raw.githubusercontent.com/efimerspan/tau/master/assets/kiosk.jpg
  38. https://raw.githubusercontent.com/efimerspan/tau/master/assets/channel.jpg
  39. https://raw.githubusercontent.com/efimerspan/tau/master/assets/stream.jpg
  40. ** Contributing
  41. You can use the project's [[https://lists.sr.ht/~conses/tau][mailing list]] to send feedback, patches or open discussions. Bugs should be reported on the project's [[https://todo.sr.ht/~conses/tau][bug-tracker]].