# -*- mode: org; org-html-head-include-default-style: nil; org-html-postamble: nil; -*-
#+OPTIONS: toc:nil num:nil
* Tubo
Tubo is an alternative web front-end to various streaming sites. It aims to free users from the world of ad-ridden streaming sites by providing a distraction-free interface to consume content from. It currently supports the following platforms:

- YouTube
- SoundCloud
- media.ccc.de
- PeerTube
- Bandcamp

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.

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.

** Installation
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 use the project's [[https://lists.sr.ht/~mmoreno/tubo][mailing list]] to send feedback, patches or open discussions. Bugs should be reported on the project's [[https://todo.sr.ht/~mmoreno/tubo][bug-tracker]].