From 77e0e8c6df3b85a26e98a72ee673d0cc01ed09c3 Mon Sep 17 00:00:00 2001 From: inflac Date: Fri, 19 Apr 2024 15:15:29 +0200 Subject: [PATCH] update readme --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5c1c89b..fe1a104 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ [![Build Chain](https://github.com/HackerspaceBielefeld/Nextride2-infobeamer/actions/workflows/ci.yml/badge.svg)](https://github.com/HackerspaceBielefeld/Nextride2-infobeamer/actions/workflows/ci.yml) - # Nextride2-infobeamer Nextride2-infobeamer is an extension for [Nextride2](https://github.com/HackerspaceBielefeld/Nextride2) and implements a simple solution to display images on screens running Nextride. N2i allows you to fetch a schedule and create a queue from the url elements. Those ressources are than itteratively displayed on the Nextride screens. @@ -10,7 +9,7 @@ N2i also implements a CMS for user uploaded date. This can be used to allow gues 1. Clone the repository 2. Create a new github OAuth application [here](https://github.com/settings/applications/new) 3. Choose a name, the url to the index page and a description -4. As Authorization callback URL use http://yourdomain.tld/auth +4. As Authorization callback URL use http://yourdomain.tld/auth (http://127.0.0.1/auth for local development) 5. Register the app 6. Create a file named `.env` in the `html` folder. 7. Enter the information based on the sample file `dot_env_example`. @@ -19,7 +18,11 @@ N2i also implements a CMS for user uploaded date. This can be used to allow gues 10. Install the necessary requirements with `pip install -r requirements.txt` 11. Enter the html folder again and start the application with `python app.py` +### Additional Steps +* You can Customize the favicong by changing the file `favicon.ico` in the HTML folder + ## Nextride2 Setup(for development) +Setting up Nextride2 is not necessary in order to use the CMS. In order to setup nextride2 for testing and development, do the following steps: 1. Clone the repository 2. Open it with Android Studio @@ -33,9 +36,6 @@ Please use the latest release for a stable and secure version of N2i. ## Todos General: -* return errorpage with good errormessages - * IMPORTANT: DONT REFLECT USER INPUT IN NO CASE; NEVER; EVER; NONONO -Admin dashboard: -Unit testing -* Setup unittests -* Create a CI pipeline +* Setup more unittests +* Fix marked todos in code +* Add documentation and fix docstrings