ursbraem / kursausschreibung Goto Github PK

View Code? Open in Web Editor NEW

This project forked from bkd-mba-fbi/kursausschreibung

0.0 1.0 0.0 2.87 MB

Evento JS Module for online course announcement

License: MIT License

JavaScript 71.71% HTML 10.77% CSS 2.28% Handlebars 15.24%

kursausschreibung's Introduction

kursausschreibung 3.3.0

Prerequisites

You will need the following things properly installed on your computer.

Installation

git clone https://github.com/bkd-mba-fbi/kursausschreibung.git
cd kursausschreibung
npm install
cd node_modules/uikit
npm install
npm run scope (make sure node is up to date)

Problem npm install

For one reason or another, some people can't connect to the registry via HTTPS. This can be fixed by setting the registry to use HTTP instead:

npm config set registry http://registry.npmjs.org/
npm config set strict-ssl false

Running / Development

ember serve
Visit your app at http://localhost:4200.
Visit your tests at http://localhost:4200/tests.

Code Generators

Make use of the many generators for code, try ember help generate for more details

Running Tests (tests not yet implemented)

ember test
ember test --server

Linting

npm run lint:js
npm run lint:js -- --fix

Building

ember build (development)
ember build --environment production (production)

Documentation

Go to the Wiki

Configuration (appconfig, settings, locale)

appconfig: The basic configuration for the module must be stored in appconfig. Example: apiUrl, webBaseUrl, oauthUrl, instanceId, clientId, applicationScope
settings: In this file you will find all settings for the module.
locale: In the 'locale' folder you will find every translation for the module that does not come from Evento (e.g. labels, status, process...).

Builds

You can download releases on the releases page and the latest build of the module here: kursausschreibung.zip. To use the module you first have to configure it.

Integration

For the integration into an html page you need a simple html configuration in header and body of the page in which you want to publish the module. Please see section MODULE head configuration and MODULE MAIN APPLICATION in index.html.

If you want to be sure that after authentication by the module the correct address is always used use OPTION REDIRECT in the index.html GoTo. Please put script element between head and body of main page (load faster).

kursausschreibung's People

Contributors

Watchers

kursausschreibung's Issues

Override settings & config in page context

While settings.js and appConfig.js are still in place, can we override them with inline JS on different pages?

URL contains %20

In some slugs, there will be whitespace and thus sometimes %20 signs:

http://www.bffbern.ch/de/weiterbildung_erziehung_und_soziales_kurse_und_zertifikatslehrgaenge_info#/weiterbildung/kurs%20wb%20erziehung%2Fsoziales

https://www.bzemme.ch/kurseweiterbildung/#/weiterbildung/informatik%20(wb)

On one hand, maybe the URL should be created more robustly, with UIDs?
On the other hand, this maybe the whitespace can be replaced with a _?

Authenticate via PHP

We will use the plugin in many different forms on various pages.
But the authentication is for one URL only. ERZ can't add all pages' URLs to their auth list.
So they recommended we disable autologin completely in appConfig.js

// set this to true if you want to use autologin on your page
"useAutoLogin": false,

If we would use the auto login with the domain only, then there would be a redirect to ` "webBaseUrl": "https://evento.stubr-dev.ch". I still don't really understand why the redirect is needed,

What I do understand is that it's a security issue to authenticate via JS, because JS can't keep a secret.

The recommendation is that we get the token ourselves via PHP (oAuth) and send it to the browser. As long as the token is valid, it's fine, it doesn't have to be recreated at each visit.

We have to see if this works with Litespeed Cache, which would be a pity if we couldn't use it.

The token is in LocalStorage:

Modify list template (optional)

https://github.com/erz-mba-fbi/kursausschreibung/blob/master/app/templates/components/event-list-item.hbs

Filter by EventCategory in addition to HostId

We want to allow different lists than only by HostId.
Most importanty, lists filtered by EventCategoryIds.

Or, in German:

Im Moment ist es nur möglich, nach der HostId (Veranstalter) zu filtern, das werden die obigen Begriffe sein wie Kurs WB Zebra.
Wir möchten aber mindestens nach "EventCategory" (Kategorie) filtern können, damit ihr – nur als Beispiel – eine Liste mit allen Sprachkursen (EventCategory 1023) auf einer Seite anzeigen könnt.

Ignore config files

If working with more than a downloaded build, it can be confusing when the settings and appConfig are versioned.

I have excluded them in https://github.com/ursbraem/kursausschreibung/tree/feature/ignore_configs and put example data there instead