klovaaxel / meeting-room-display

PWA for meeting room displays that fetch from a ICS file

Home Page:https://klovaaxel.github.io/meeting-room-display/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Meeting room display

GitHub contributors GitHub last commit GitHub issues GitHub repo size

PWA for meeting room displays that fetch from a ICS file Github Pages Deployment

Contents

Supported calendars

The calendar is linked with a ical ICS feed with a public link, dependig on what URL and domain you are using you might need to disable CORS on your browser/whitelist this webpage from using CORS

  • ✔ Outlook Calendar
  • ✔ Google Calendar

How to get ICAL/ICS feed from your calendar

This largley depends on what calendar you are using.
(See "Supported calendars" for a list of calendar this PWA has been tested with)

Outlook Calendar

For Outlook you can publish an ICS feed if you go to

  • Settings (Cog up in the right corner),
  • All outlook calendar settings,
  • Shared calendars,
  • Publish a calendar

Link to more indepth tutorial
Link to share a Room Outlook calendar

Google Calendar

For Google Calendar you can publish an ICS feed if you go to

  • Settings (Cog up in the right corner),
  • Choose the calednar you want to choose, (in the left menu)
  • Make your calendar publicaly available under "Access permissions for events",
  • To get the direct ics link go to "Integrate calendar" section and there it is in the "Public adress in iCal format" box Link to Google documentation

Installation

The calendar is linked with a public link to an ical ICS feed

This means that you might need to do one of the following

Steps to install

  1. Ethier use this github pages as is or fork this repository and publsih your fork as a webpage accessible form your hardware.

    • If forked or downloaded, customize your version with your branding!
  2. Share/Publish your calendar as a ics feed with a url that your hardware can access. (see How to get ICAL/ICS feed from your calendar)

  3. On your hardware navigate to the public webpage and download the PWA (on ios add it to homescreen)

  4. Lock your hardware to the PWA and make it open it on boot!

  5. Enter room/screen name, and your ICS url on the webpage and press continue and the info should be displayed.

    • If you used a proxy server to get around CORS issues use the link you get from it.
  6. You can also add the name and ics url into the url by appending ?name=YourName&icsurl=YourICSURL. This can be done for sharing links to your rooms calendar/availabilty

How to contribute

  1. Create a fork of this project
  2. (Recomended) Make a dev branch on your fork (so thay you can recive uppstream changes on your main branch)
  3. Make your changes!
  4. Put all your changes into the correct branch
  5. Make a pull request!
  6. Wait for approval

Contributors