Frontend to manage edisplay-backend. Has all CRUD operations implemented to manage Displays, Locations, Connections and Templates. Fully created with Vue.js
Table of Contents
Clone this repository
git clone https:/noi-techpark/e-ink-displays-webapp
Get all dependencies
yarn install
Set up the Backend if not already done. Follow README to setup the Backend.
And start the Frontend. It will run on localhost
yarn serve
- Set up the API by following the README there
- Set up a Physical display by following the README of the backend
- Set the IP-Address of the machine where you run the
API in
.env
file in root directory. You can copy the defaults from.env.example
. Note: If you are using Vue cli 3, only variables that start with VUE_APP_ will be loaded.
VUE_APP_API_URL=http://localhost:8081
- Start the webapp
yarn serve
- Create an image with the size 640*384 that you want to send to the display
- Open a browser to open the webapp on localhost
- Login with the credentials
user:user
password:pass
- Click on Create
- Create a template by giving it a name and uploading the image you created
- Create a display by giving it a name and choosing the template you created before
- Create a location by giving it a name
- Create a connection between the display and the location and in the field network address put the IP-Address of the physical displat you created in step 2 like (it's important to put the protocol and the 80 port)
http://192.168.1.4:80
- Click on Dashboard where you should see your created display
- Click on send to send the image to the display or on clear to clear the screen
yarn build
The E-Display Backend is free software. It is licensed under GNU GENERAL PUBLIC LICENSE Version 3 from 29 June 2007. More info can be found here
No third party components used for now
This project is REUSE compliant, more information about the usage of REUSE in NOI Techpark repositories can be found here.
Since the CI for this project checks for REUSE compliance you might find it useful to use a pre-commit hook checking for REUSE compliance locally. The pre-commit-config file in the repository root is already configured to check for REUSE compliance with help of the pre-commit tool.
Install the tool by running:
pip install pre-commit
Then install the pre-commit hook via the config file by running:
pre-commit install