Miguel Ángel Moreno
5e995881dd
chore: Reword README and remove assets
|
2 سال پیش | |
|---|---|---|
| assets | 2 سال پیش | |
| classes | 2 سال پیش | |
| resources | 2 سال پیش | |
| src | 2 سال پیش | |
| .dir-locals.el | 2 سال پیش | |
| .gitignore | 2 سال پیش | |
| LICENSE | 2 سال پیش | |
| README | 2 سال پیش | |
| deps.edn | 2 سال پیش | |
| manifest.scm | 2 سال پیش | |
| package-lock.json | 2 سال پیش | |
| package.json | 2 سال پیش | |
| postcss.config.js | 2 سال پیش | |
| shadow-cljs.edn | 2 سال پیش | |
| tailwind.config.js | 2 سال پیش | |
| webpack.config.js | 2 سال پیش |
README
# -*- mode: org; org-html-head-include-default-style: nil; org-html-postamble: nil; -*-
#+OPTIONS: toc:nil
* Tau
An alternative front-end to various streaming sites. The aim of Tau 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. Tau exposes the extracted data over a REST API that is consumed by a local re-frame SPA.
The ultimate goal behind Tau 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 Tau's dependencies is via the [[https://guix.gnu.org/][GNU Guix]] package manager. Simply invoke what follows:
#+begin_src sh
cd /path/to/tau
guix shell
#+end_src
To run the application, first compile the downloader ahead-of-time.
#+begin_src sh
clojure -M -e "(compile 'tau.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 tau
#+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=.
** Screenshots
https://raw.githubusercontent.com/efimerspan/tau/master/assets/kiosk.jpg
https://raw.githubusercontent.com/efimerspan/tau/master/assets/channel.jpg
https://raw.githubusercontent.com/efimerspan/tau/master/assets/stream.jpg
** Contributing
You can use the project's [[https://lists.sr.ht/~conses/tau][mailing list]] to send feedback, patches or open discussions. Bugs should be reported on the project's [[https://todo.sr.ht/~conses/tau][bug-tracker]].
#+OPTIONS: toc:nil
* Tau
An alternative front-end to various streaming sites. The aim of Tau 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. Tau exposes the extracted data over a REST API that is consumed by a local re-frame SPA.
The ultimate goal behind Tau 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 Tau's dependencies is via the [[https://guix.gnu.org/][GNU Guix]] package manager. Simply invoke what follows:
#+begin_src sh
cd /path/to/tau
guix shell
#+end_src
To run the application, first compile the downloader ahead-of-time.
#+begin_src sh
clojure -M -e "(compile 'tau.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 tau
#+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=.
** Screenshots
https://raw.githubusercontent.com/efimerspan/tau/master/assets/kiosk.jpg
https://raw.githubusercontent.com/efimerspan/tau/master/assets/channel.jpg
https://raw.githubusercontent.com/efimerspan/tau/master/assets/stream.jpg
** Contributing
You can use the project's [[https://lists.sr.ht/~conses/tau][mailing list]] to send feedback, patches or open discussions. Bugs should be reported on the project's [[https://todo.sr.ht/~conses/tau][bug-tracker]].