docs: run instrcutions

This commit is contained in:
Ante Brähler
2024-11-17 20:35:13 +01:00
parent 6e5bb56da2
commit 38995bdb5b
2 changed files with 28 additions and 0 deletions

20
backend/README.md Normal file
View File

@@ -0,0 +1,20 @@
# Frontend
⚠️ The Application is currently under active development. A dockerized solution will be provided in the near future! ⚠️
## Run
Setup a `.env` file or
equivalent environment variables:
```env
DEFAULT_CHANNEL_URL=https://mcdn.daserste.de/daserste/de/master.m3u8
STORAGE_PATH=/mnt/streams/recordings
```
The storage directory has to exist. There will be alot of I/O, so it makes sense to mount the storage into ram memory.
Before running, make sure you have `ffmpeg` installed on your system.
```bash
node index.js
```
Be aware, that this application is designed for Linux systems!

8
frontend/README.md Normal file
View File

@@ -0,0 +1,8 @@
# Frontend
⚠️ The Application is currently under active development. The connection to the backend isn't done yet! ⚠️
## Run
```bash
npm install
npm run dev
```