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

README 2.0 KB
History Raw

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

  2. #+OPTIONS: toc:nil num:nil
    3. 

  3. * Tubo
    4. 

  4. Tubo is a streaming front-end focused on bringing the [[https://github.com/TeamNewPipe/NewPipe][NewPipe]] experience to the web. It currently supports the same platforms as NewPipe, including YouTube, SoundCloud, and more.
    5. 

  5. 

  6. To retrieve the data, it wraps the excellent [[https://github.com/TeamNewPipe/NewPipeExtractor][NewPipe Extractor]] library and exposes the extracted data over a REST API that is consumed by a local re-frame SPA.
    7. 

  7. 

  8. ** Try It Out
    9. 

  9. You can try a live demo at https://tubo.mianmoreno.com but beware this is hosted on a personal low-end VPS. If you can, please consider self-hosting Tubo and let me know about your instance via the [[*Contributing][contribution methods]]. See [[*Installation][installation]] for ways to set up Tubo in your server.
    10. 

  10. 

  11. ** Installation
    12. 

  12. *** Manual
    13. 

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

  14. 

  15. #+begin_src sh
    16. 

  16. cd /path/to/tubo
    17. 

  17. guix shell
    18. 

  18. #+end_src
    19. 

  19. 

  20. To run the application, first compile the downloader ahead-of-time.
    21. 

  21. 

  22. #+begin_src sh
    23. 

  23. clojure -M -e "(compile 'tubo.downloader-impl)"
    24. 

  24. #+end_src
    25. 

  25. 

  26. Fetch the front-end dependencies and build the front-end assets.
    27. 

  27. 

  28. #+begin_src sh
    29. 

  29. npm i
    30. 

  30. npm run build
    31. 

  31. #+end_src
    32. 

  32. 

  33. Then, compile the front-end.
    34. 

  34. 

  35. #+begin_src sh
    36. 

  36. clojure -M:frontend compile tubo
    37. 

  37. #+end_src
    38. 

  38. 

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

  40. 

  41. #+begin_src sh
    42. 

  42. clojure -M:run
    43. 

  43. #+end_src
    44. 

  44. 

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

  46. 

  47. ** Road-map
    48. 

  48. - [X] Basic audio player
    49. 

  49. - [ ] Track queuing system
    50. 

  50. - [ ] Playlists
    51. 

  51. - [ ] User settings
    52. 

  52. 

  53. ** Screenshots
    54. 

  54. [[https://files.mianmoreno.com/tubo_kiosk.jpg]]
    55. 

  55. [[https://files.mianmoreno.com/tubo_channel.jpg]]
    56. 

  56. [[https://files.mianmoreno.com/tubo_stream.jpg]]
    57. 

  57. 

  58. ** Contributing
    59. 

  59. You can send feedback, patches, or bug reports to [[mailto:public@mianmoreno.com][public@mianmoreno.com]].
    60.