README 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. # -*- mode: org; org-html-head-include-default-style: nil; org-html-postamble: nil; -*-
  2. #+OPTIONS: toc:nil
  3. * Tau
  4. A front-end alternative to various streaming 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.
  11. The easiest way to set up Tau's dependencies is via the [[https://guix.gnu.org/][GNU Guix]] package manager. Simply invoke what follows:
  12. #+begin_src sh
  13. cd /path/to/tau
  14. guix shell
  15. #+end_src
  16. To run the application, first compile the downloader ahead-of-time.
  17. #+begin_src sh
  18. clojure -M -e "(compile 'tau.downloader-impl)"
  19. #+end_src
  20. Fetch the front-end dependencies and build the front-end assets.
  21. #+begin_src sh
  22. npm i
  23. npm run build
  24. #+end_src
  25. Then, compile the front-end.
  26. #+begin_src sh
  27. clojure -M:frontend compile tau
  28. #+end_src
  29. You can now start a local server that listens on port 3000 by running the following:
  30. #+begin_src sh
  31. clojure -M:run
  32. #+end_src
  33. Access the front-end in your browser at =http://localhost:3000=.
  34. 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]].