From 50b47040539f287af33b7a1c74e78a537edfe009 Mon Sep 17 00:00:00 2001 From: github-actions Date: Wed, 3 Jan 2024 10:15:41 +0000 Subject: [PATCH] Add webapp-schulverwaltung build 9416f1a9 --- public/apps/webapp-schulverwaltung/README.md | 62 ++++--------- ...{browser-support.md => browser-testing.md} | 12 ++- .../webapp-schulverwaltung/doc/development.md | 86 +++++++++++++++++++ .../apps/webapp-schulverwaltung/doc/i18n.md | 6 +- .../apps/webapp-schulverwaltung/doc/io-ts.md | 4 +- .../webapp-schulverwaltung/doc/prettier.md | 28 ------ .../doc/setup-dev-environment.md | 39 --------- 7 files changed, 116 insertions(+), 121 deletions(-) rename public/apps/webapp-schulverwaltung/doc/{browser-support.md => browser-testing.md} (89%) create mode 100644 public/apps/webapp-schulverwaltung/doc/development.md delete mode 100644 public/apps/webapp-schulverwaltung/doc/prettier.md delete mode 100644 public/apps/webapp-schulverwaltung/doc/setup-dev-environment.md diff --git a/public/apps/webapp-schulverwaltung/README.md b/public/apps/webapp-schulverwaltung/README.md index 7ccb8cb4..baefaa4f 100644 --- a/public/apps/webapp-schulverwaltung/README.md +++ b/public/apps/webapp-schulverwaltung/README.md @@ -6,58 +6,28 @@ JavaScript web module to implement processes for school administration using the SLH.Evento backend (REST API). -[Demo](https://bkd-mba-fbi.github.io/webapp-schulverwaltung/app) +This project is realized with [Angular](https://angular.io/), [Bootstrap](https://getbootstrap.com/) and [io-ts](https://github.com/gcanti/io-ts). It is open source software, licensed under the terms of the [MIT license](./LICENSE). -## Integration +Download the [latest build](https://bkd-mba-fbi.github.io/webapp-schulverwaltung/webapp-schulverwaltung.zip) or checkout the [Demo](https://bkd-mba-fbi.github.io/webapp-schulverwaltung/app). -Download the [latest build](https://bkd-mba-fbi.github.io/webapp-schulverwaltung/webapp-schulverwaltung.zip). +## Documentation -To integrate this application in your website, you have to copy and -paste the import of the `settings.js` and the CSS files from -`index.html`'s ``: +### Evento Portal -``` - - - - -``` +Although it can be used standalone during development, the _webapp-schulverwaltung_ is embedded in the [Evento Portal](https://github.com/bkd-mba-fbi/evento-portal) and developed by the same team, therefore the documentation of the _Evento Portal_ is relevant for this project to a large extent too, especially the following documents: -In addition, you have to copy and paste the app tag and all ` - ... - - -``` +### General -To configure the app, you have to rename the file -`settings.example.js` to `settings.js` and adjust its contents. +- [Wiki](https://github.com/bkd-mba-fbi/webapp-schulverwaltung/wiki) – Common topics -### Authorization +### Development -The website integrating this application has to make sure the OAuth -access token is available in localStorage (or sessionStorage) under -the key `CLX.LoginToken` (e.g. by setting -`localStorage.setItem('CLX.LoginToken', '...')`). If not provided, the -application displays a unauthenticated message to the user. - -### Important Notes - -- When integrated into the Evento Application, the App is wrapped in a - `
` tag. It is therefore important, that all `