Presentium

Project Presentium

Scalable presence control system using RFID student cards.

Context

Presentium is a group project done as part of the PDG class of HEIG-VD, Switzerland.

The goal of the project is to streamline taking student attendance using RFID student cards. The project is developed as mandated by the Project Description.

The complete documentation about the project, its structure, and its components can be found in the Wiki.

Project Structure

The project is divided into several repositories, the main components are described below:

Meta repositories

Meta: Repository containing the project's documentation and general information.
Landing: The landing page for the project.

Web

Dashboard: The dashboard application for teachers and students.
API: The backend API handling communication with reader devices and data for the dashboard.

Client (Raspberry Pi devices)

Client app: The client app used to connect to the API on reader devices.
APT repository: A repository serving as an APT repository for reader devices.
Operating System (OS): The operating system running on the Raspberry Pi.

Infrastructure

Infrastructure: The infrastructure as code of the project, deploying the dashboard application and required services on AWS.
Kubernetes: The kubernetes files managed by ArgoCD for deploying the application and infrastructure.

Other repositories may be created for specific components or features, their usecases should be detailed in their description as well as in the Wiki.

Running locally

To get the dashboard and API up and running (with a mock gRPC client if necessary), you'll need to clone the dashboard and API repositories. The dashboard is tightely coupled to the API, but not otherwise. To have all necessary dependencies for both components, you'll simply need to start the Spring Boot API in development mode as described in the API repository README.

The dashboard repository has additional information about configuring the environment variables (which basically only requires copying the sample file).