README 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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 and restrictions, by providing you with a minimal interface to enjoy your favorite content from these sites. 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. I built Tau because I stopped using Android and wanted to replicate the Newpipe experience both on desktop and mobile GNU/Linux.
  11. ** Installation
  12. The easiest way to set up Tau's dependencies is via the [[https://guix.gnu.org/][GNU Guix]] package manager. Simply invoke what follows:
  13. #+begin_src sh
  14. cd /path/to/tau
  15. guix shell
  16. #+end_src
  17. To run the application, first compile the downloader ahead-of-time.
  18. #+begin_src sh
  19. clojure -M -e "(compile 'tau.downloader-impl)"
  20. #+end_src
  21. Fetch the front-end dependencies and build the front-end assets.
  22. #+begin_src sh
  23. npm i
  24. npm run build
  25. #+end_src
  26. Then, compile the front-end.
  27. #+begin_src sh
  28. clojure -M:frontend compile tau
  29. #+end_src
  30. You can now start a local server that listens on port 3000 by running the following:
  31. #+begin_src sh
  32. clojure -M:run
  33. #+end_src
  34. Access the front-end in your browser at =http://localhost:3000=.
  35. ** Screenshots
  36. Tau aims to create a uniform interface between all the aforementioned services. Hence, as in Newpipe, many interface elements are shared.
  37. [[file:assets/kiosk.jpg]]
  38. [[file:assets/channel.jpg]]
  39. [[file:assets/stream.jpg]]
  40. [[file:assets/mobile_comments.jpg]]
  41. [[file:assets/mobile_nav.jpg]]
  42. ** Contributing
  43. 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]].