A Vue.js-based media library and stream web app for your community radio.
This project requires *NodeJS* and *npm*. If any of the commands below are
not available on your computer, see the [System Requirements](#system-requirements)
section at the end of this document.
## About
*Thekno* is a [Progressive Web App](https://en.wikipedia.org/wiki/Progressive_web_applications) and a reference implementation for a set of APIs formalized as part of this project.
By implementing these APIs any community radio will be able to offer a Web App for their listeners who will be able to install it similar to a native app. *Thekno* offers a variety of configuration options for providers including live streams, social platforms, content suggestions and more.
## Design Goals
***Familiarity**
*Thekno* should feel and behave like other apps that people use on their phones and desktops.
***Explorable**
*Thekno* should encourage users to explore the diversity of your community radio. Both new content and content that matches the user’s interest should be easy to find.
***Privacy**
*Thekno* aims for client-storage only and embraces the data sovereignty of its users. Personal information should only be stored on the users device.
### Development and Testing Workflow
This project requires *NodeJS* and *npm*. If any of the commands below are
not available on your computer, see the [System Requirements](#system-requirements)
section at the end of this document.
The project uses numerous external dependencies that you can install with the
`npm install` command. After that you can just run `npm run serve` to start up
a development server.
*thekno* ships with fixtures that do not require a backend server, but in case
*Thekno* ships with fixtures that do not require a backend server, but in case
you do want to work with the [Lohrothek REST API](https://git.hack-hro.de/lohro/lohrothek/lohrothek-api)
you can do that. The development server started by `npm run serve` will proxy all
requests to the `/api/` endpoint to `http://localhost:8000/` by default. This
...
...
@@ -35,7 +58,7 @@ VUE_APP_APIORIGIN=https://thek.lohro.de npm run serve
```
You may also use the included docker script `scripts/docker.sh`. It will build
and start *thekno* in an environment similar to those in production. Providing
and start *Thekno* in an environment similar to those in production. Providing
a [custom environment](#environments-and-configuration) is possible with the
`--build-arg` option like this:
...
...
@@ -56,18 +79,18 @@ report any errors (that did not exist before 😅).
VueJS provides a build target out of the box. You can create a build with
`npm run build` and deploy the contents of the `build/dist` directory
afterwards. There is also a `Dockerfile` that can be used to create docker
images (in fact it’s used to automatically deploy *thekno* to our
images (in fact it’s used to automatically deploy *Thekno* to our
[staging server](https://thekno.farbdev.org)).
There will also be a deb package for Debian at a later point.
See [Custom Environments](#custom-environments) for a way to alter the
default behaviour of *thekno*.
default behaviour of *Thekno*.
## Environments and Configuration
*thekno* supports extensive environment runtime configuration. See the
*Thekno* supports extensive environment runtime configuration. See the
[Environment Configuration](./docs/environment-configuration.md) document for
The API is based on three pillars namely series’, broadcasts, and recordings.
A short nomenclature:
Series
: A radio program or show that is usually scheduled to be aired on a regular interval.
Broadcast
: An instance of a series or in less technical terms the time and date when a series has been aired.
Recording:
: A segment, report, or story that encapsulates the actual audio data.
Every series has multiple broadcasts and every broadcast usually has multiple recordings. It may also happen that a recording was aired more than once so that it appears in multiple broadcasts. Vice versa you may find recordings that are not associated to any broadcast. In that case the Recording was never aired and was only submitted for archival purposes.
"description":"Nach über 6 Jahren fand an der Universität Rostock eine Vollversammlung statt. Über 650 Studierende versammelten sich zum Debattieren und Abstimmen im Audimax zusammen. Bei einer anschließenden Bildungsdemonstration sprachen neben Studierenden unter anderem Prof. Dr. Wolfgang Schareck (Rektor) und Kai Hörig (Geschäftsführer Studierendenwerk) und stellten selbst Forderungen an das Land.",
