[U] readme

This commit is contained in:
Jan 2020-07-17 11:24:20 +02:00
parent 7bc4ae89b1
commit f105aa5e50
3 changed files with 37 additions and 2 deletions

View file

@ -1,5 +1,40 @@
# Webframe # Webframe
![WebFrame](example.jpg)
A simple digital picture frame as a website. A simple digital picture frame as a website.
Inspired by TeleFrame https://github.com/LukeSkywalker92/TeleFrame With webframe you can turn any device with a screen and browser into a digital picture frame.
To minimize friction (sync, multi user support) the images are downloaded from a webdav share (e.g. [nextcloud](https://nextcloud.com/)).
This project is heavily inspired by [TeleFrame](https://github.com/LukeSkywalker92/TeleFrame).
# Config
```
WEBDAV_URL=https://your.webdav.host
WEBDAV_USER=user
WEBDAV_PW=pass
WEBFRAME_PATH=/path/to/imgs/
PORT=3000
POLL_TIMEOUT=60000
```
# run
```
git clone ...
npm install
node index.js
```
# tech
## backend
- [express.js](https://github.com/expressjs/express)
- [webdav-client](https://github.com/perry-mitchell/webdav-client)
- [lowdb](https://github.com/typicode/lowdb)
## frontend
- [vue.js v2](https://github.com/vuejs/vue)
- svg-
icons from [css.gg](https://github.com/astrit/css.gg)

BIN
example.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 270 KiB

View file

@ -43,7 +43,7 @@ function loadImages() {
} }
}); });
} }
}); }).catch(e => console.error('Path', process.env.WEBFRAME_PATH, 'not found.'));
setTimeout(() => loadImages(), process.env.POLL_TIMEOUT); setTimeout(() => loadImages(), process.env.POLL_TIMEOUT);
} }