diff --git a/README.md b/README.md index 03efdb4..9604ea4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,40 @@ # Webframe +![WebFrame](example.jpg) + 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) \ No newline at end of file diff --git a/example.jpg b/example.jpg new file mode 100644 index 0000000..f9996d3 Binary files /dev/null and b/example.jpg differ diff --git a/index.js b/index.js index 5cde06a..c6e1149 100644 --- a/index.js +++ b/index.js @@ -43,7 +43,7 @@ function loadImages() { } }); } - }); + }).catch(e => console.error('Path', process.env.WEBFRAME_PATH, 'not found.')); setTimeout(() => loadImages(), process.env.POLL_TIMEOUT); }