event-information

Display events from evento api to add this to entrance of a buildung or of a room.

How to use

This module can be used to display buildings. For example, building entrances to display events in this building. It is possible to set a parameter using the event color (Evento tab lesson) so that only these events are displayed. It is also possible to create a room display if the roomId parameter is called in the URL.

If you are an Evento school of the Canton of Bern, you can use the module directly via the URL https://event-information.netlify.app.

If not, you can download the latest release and install it on any web server. You must then configure the 3 properties in settings.js. In Evento OAuth you have to create a Public ConsumerType that has access to the Scope Public with the endpoint GET /RoomReservation on the EndpointList.

Parameter

Mandatory parameters are buildingId or roomId and instanceId

Options

refresh: to get new occupancies from restApi in min (default 1min)
color: filter to event color would you like to display on the screen (HEX without # in param)
headerColor: Color for the header (HEX without # in param)
siteChange: Interval to go to next site if more then 1 site in sec (default 3.5sec)

E.g.

Auth

At startup, the module checks whether a valid token is present in the sessionStorage.evtToken. Valid means the exp has not expired and the instanceId of the token corresponds to the token and the navigatorlanguage corresponds to the token culture_info. If not, a GET is made to the following endpoint.

${settings.authUrl}/Authorization/${param.instanceId}/Token?clientId=${settings.clientId}&redirectUrl=${location.href}&culture_info=${navigatorLanguage}&application_scope=Public

If the consumer is registered in OAuth, a new accessToken is sent to the client, which reads the accessToken into the sessionStorage.evtToken.

Content

Param buildingId

Header: Rooms.Building

Table rows:

Occupancies.DateTimeFrom - Occupancies.DateTimeFrom (format hh:mm)
Occupancies.Designation
Occupancies.Floor
Occupancies.Ressource

Param roomId

Header: Rooms.Ressource Rooms.Building

Table rows:

Occupancies.DateTimeFrom - Occupancies.DateTimeFrom (format hh:mm)
Occupancies.Designation

Branching & Releasing

For development use the dev branch and commit your changes to this. We review all changes on the dev branch an made a pull request to main after everything ist good or we find a new release must be create.

Release

Do a pull request from dev to main.
Title semantic version number (E.g. 1.1.0)
Commit meesage only version number
New release create by action
if action finished generate auto relasee notes an save

Action on main branch

Build app
change settings propertys for production
create zip file
Deploy app ti gh_pages/dist folder
Create Release with tag COMMIT_SHORT_SHA
Upload zip file to Release

Setup & Development

Getting Started

Install the dependencies:

npm install

Copy settings.example.js to settings.js and adjust its contents.

Start the development server:

npm run dev

Responsive Design

font-size and padding are calculated by screen size.

font-size: calc(1.3rem + 1.1vw)
padding: calc(0.1rem + 2vw);

if smaller than 850px:

font-size: calc(0.8rem + 1.55vw)

bkd-mba-fbi / event-information Goto Github PK