No Description

Miguel Ángel Moreno 81f03c0b44 chore: Rename project 2 years ago
assets 5e995881dd chore: Reword README and remove assets 2 years ago
classes b545944e71 chore(git): Unignore classes directory 2 years ago
resources 81f03c0b44 chore: Rename project 2 years ago
src 81f03c0b44 chore: Rename project 2 years 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 81f03c0b44 chore: Rename project 2 years ago
deps.edn 81f03c0b44 chore: Rename project 2 years 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
* Tubo
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:

- 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://raw.githubusercontent.com/efimerspan/tubo/master/assets/kiosk.jpg]]
[[https://raw.githubusercontent.com/efimerspan/tubo/master/assets/channel.jpg]]
[[https://raw.githubusercontent.com/efimerspan/tubo/master/assets/stream.jpg]]

** Contributing
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]].