No Description

Miguel Ángel Moreno cc7d14514c feat: Add tools.build script 1 year ago
classes b545944e71 chore(git): Unignore classes directory 2 years ago
resources 81f03c0b44 chore: Rename project 2 years ago
src 5d769697b3 fix: Fix project source URL 1 year ago
.dir-locals.el 81f03c0b44 chore: Rename project 2 years ago
.gitignore b545944e71 chore(git): Unignore classes directory 2 years ago
LICENSE 916ba00f83 chore: Add license 2 years ago
README c794f2d1c4 doc: Update description and add live demo link 1 year ago
README.md b8291c2ffb doc: Update Markdown version of README 1 year ago
build.clj cc7d14514c feat: Add tools.build script 1 year ago
deps.edn cc7d14514c feat: Add tools.build script 1 year ago
manifest.scm 80bb68bcad chore(guix): Add manifest 2 years ago
package-lock.json 67007e8bdd feat(frontend): Introduce video.js for stream playback 2 years ago
package.json 67007e8bdd feat(frontend): Introduce video.js for stream playback 2 years ago
postcss.config.js b2c3fecbd1 chore: Add PostCSS configuration 2 years ago
shadow-cljs.edn 81f03c0b44 chore: Rename project 2 years ago
tailwind.config.js 26b7abf933 chore(tailwind): Add more screen sizes 2 years ago
webpack.config.js 81f03c0b44 chore: Rename project 2 years ago

README

# -*- mode: org; org-html-head-include-default-style: nil; org-html-postamble: nil; -*-
#+OPTIONS: toc:nil num:nil
* Tubo
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.

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.

** Try It Out
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.

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

#+begin_src sh
cd /path/to/tubo
guix shell
#+end_src

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

#+begin_src sh
clojure -M -e "(compile 'tubo.downloader-impl)"
#+end_src

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

#+begin_src sh
npm i
npm run build
#+end_src

Then, compile the front-end.

#+begin_src sh
clojure -M:frontend compile tubo
#+end_src

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

#+begin_src sh
clojure -M:run
#+end_src

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

** Road-map
- [X] Basic audio player
- [ ] Track queuing system
- [ ] Playlists
- [ ] User settings

** Screenshots
[[https://files.mianmoreno.com/tubo_kiosk.jpg]]
[[https://files.mianmoreno.com/tubo_channel.jpg]]
[[https://files.mianmoreno.com/tubo_stream.jpg]]

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