Home Explore Help
Sign In
poesty
/
tubo
forked from mirrors/tubo
1
0
Fork 0
Files
Tree: 81f03c0b44
Branches Tags
tubo
/
README

README 2.2 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263 
  1. # -*- mode: org; org-html-head-include-default-style: nil; org-html-postamble: nil; -*-
    2. 

  2. #+OPTIONS: toc:nil
    3. 

  3. * Tubo
    4. 

  4. An alternative front-end to various streaming sites. The aim of Tubo 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. 

  5. 

  6. - YouTube
    7. 

  7. - SoundCloud
    8. 

  8. - media.ccc.de
    9. 

  9. - PeerTube
    10. 

  10. - Bandcamp
    11. 

  11. 

  12. 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. Tubo exposes the extracted data over a REST API that is consumed by a local re-frame SPA.
    13. 

  13. 

  14. The ultimate goal behind Tubo is to replicate the Newpipe experience on the web, so that it's accessible to those that don't use an Android device.
    15. 

  15. 

  16. ** Installation
    17. 

  17. The easiest way to set up Tubo's dependencies is via the [[https://guix.gnu.org/][GNU Guix]] package manager. Simply invoke what follows:
    18. 

  18. 

  19. #+begin_src sh
    20. 

  20. cd /path/to/tubo
    21. 

  21. guix shell
    22. 

  22. #+end_src
    23. 

  23. 

  24. To run the application, first compile the downloader ahead-of-time.
    25. 

  25. 

  26. #+begin_src sh
    27. 

  27. clojure -M -e "(compile 'tubo.downloader-impl)"
    28. 

  28. #+end_src
    29. 

  29. 

  30. Fetch the front-end dependencies and build the front-end assets.
    31. 

  31. 

  32. #+begin_src sh
    33. 

  33. npm i
    34. 

  34. npm run build
    35. 

  35. #+end_src
    36. 

  36. 

  37. Then, compile the front-end.
    38. 

  38. 

  39. #+begin_src sh
    40. 

  40. clojure -M:frontend compile tubo
    41. 

  41. #+end_src
    42. 

  42. 

  43. You can now start a local server that listens on port 3000 by running the following:
    44. 

  44. 

  45. #+begin_src sh
    46. 

  46. clojure -M:run
    47. 

  47. #+end_src
    48. 

  48. 

  49. Access the front-end in your browser at =http://localhost:3000=.
    50. 

  50. 

  51. ** Road-map
    52. 

  52. - [X] Basic audio player
    53. 

  53. - [ ] Track queuing system
    54. 

  54. - [ ] Playlists
    55. 

  55. - [ ] User settings
    56. 

  56. 

  57. ** Screenshots
    58. 

  58. [[https://raw.githubusercontent.com/efimerspan/tubo/master/assets/kiosk.jpg]]
    59. 

  59. [[https://raw.githubusercontent.com/efimerspan/tubo/master/assets/channel.jpg]]
    60. 

  60. [[https://raw.githubusercontent.com/efimerspan/tubo/master/assets/stream.jpg]]
    61. 

  61. 

  62. ** Contributing
    63. 

  63. You can use the project's [[https://lists.sr.ht/~conses/tubo][mailing list]] to send feedback, patches or open discussions. Bugs should be reported on the project's [[https://todo.sr.ht/~conses/tubo][bug-tracker]].
    64.