Student Health Staff Monitor

Table of Contents

• Introduction
• How To Change The Information Currently Displayed
• Google Drive Folder
• Documentation
• Definition of Done
• Creating branches & Merging to main
• Development Environment
• Programming Languages & Frameworks
  • Programming Languages
  • Frameworks
  • Static Site Generator
  • Code Style

Introduction

This project aims to create a digital sign system that highlights Student Health Staff, providing quick and engaging information about their availability and services.

How To Change The Information Currently Displayed

Changing the information that is displayed on the monitor is done by changing the information in this Google spreadsheet.To edit details regarding events, navigate to the 'Events' sheet and fill in the required cells, with 'DATUM' being a mandatory field. It's important to note that events will only be visible if there are 14 days or less remaining untill the day it is happening. The data on the monitor will update automatically from a couple of seconds up to a few minutes after you edit the spreadsheet.

Adding an Image

Select the cell for the person you want to add an image to in the "BILD" column. Click Insert -> Image -> Insert image in cell. Then click on Browse and select the image you want to add.

Google Drive Folder

This project has a Google Drive folder for private data. The folder contains the spreadsheet for displayed data, product backlog, passwords and more.

Documentation

The documentation should be written in English.

Definition of Done

https://docs.google.com/document/d/1oLyPqJwN76pdIZRc8FyYE1W91b1bqy2K/edit

Creating branches & Merging to main

• For every feature added, a branch should be made for the feature.
• After a feature is created and follows the Definition of Done above, create a pull request to merge it with the main branch.
• Discuss the pull request with your group members and go through any changes that need to be made.
• After the changes have been finalized and completed, a group member can then approve and merge the pull request, marking the feature as successfully implemented.

Development Environment

• How to set up a development environment
• Editor - Visual Studio Code
• Remote - SSH extension
• Version Control Host - GitHub
• OS - Windows 10
• svg Editor - Inkscape

Programming Languages & Frameworks

Programming Languages

• HTML5
• CSS3
• Python3
• JavaScript V8

Frameworks

• Bootstrap 3.4.1
• JQuery 3.6.0

Static Site Generator

• Jekyll 4.3.2 (Installed on Ruby 3.0.2)

Code Style

General

• Indentations are 4 spaces
• A line of code should be maximum of 80 characters long.
• Ensure that there is a space between comments and the '#' or '//'.

Python

• Variables and functions use snake_case

JavaScript

• Variables and functions use camelCase