dixit - The quote collector

From Latin dīxit (“he or she has said”).

Automated quote collector with a web interface and an e-paper carousel.

Getting started

Installation and usage requires at least Node 14 (for the web server) and Python 3.7 (for the e-paper client).

The e-paper client has been designed for the Waveshare's 7.5" HD HAT B but could be easily adapted to other models.

Installation

# Clone this repo
git clone https://github.com/e-kot-unamur/dixit.git

# Download dependencies for the server
cd dixit/server
npm install

# Build static files for the web client
cd ../web-client
npm install
npm run build

# Create the virtual environment for the e-paper client
cd ../epaper-client
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

cd ..

Usage

To start the server (under the server directory) :

PORT=80 npm run start

To start the e-paper carousel (in the epaper-client directory, under the previously created virtual environment) :

HOST='localhost:80' TIMEOUT=240 python main.py

Depending on your distribution, you may need to install additional packages for the python client to run (as it's using Pillow). Please refer to their documentation if you need help.

For any further documentation, please refer to the server, the web client, or the e-paper client's readmes.

License

This software is published under the MIT license.

It uses an e-paper library from the Waveshare team also published under the MIT license.