webframe/README.md
2020-07-17 11:42:24 +02:00

46 lines
No EOL
1,015 B
Markdown

# Webframe
![WebFrame](example.jpg)
A simple digital picture frame as a website.
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
cp .env.example .env
mkdir files
nano .env
node index.js
```
This also works on (old) android devices using termunx.
# 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)