Franklyn

📘 Project Description

Franklyn is a project that is meant to assist instructors by streaming current activities to the teachers screen during tests and exams. The program also allows the teacher to switch between different views, enabling monitoring of all students via a small dashboard that displays every active student screen, or viewing one individual screen in the detailed dashboard. Franklyn will also allow the teacher to look at recordings of previous exams. There will also be a login system to schedule future tests.

🛠️ Installation

📦 Requirements

• nix package manager or docker / podman

🐳 Using Docker

1. Run ./enter-env.sh
   • Usage: ./enter-env.sh [podman] [server|hugo|proctor|sentinel]
   • A nix docker container with persistent volumes will start with a shell in the terminal and you can continue at ❄️ Using Nix.

❄️ Using Nix

Clone the project and enter environment:

git clone https://github.com/2526-4ahitm-itp/2526-4ahitm-franklyn.git
nix develop

🔐 Build Sentinel:

 cd sentinel
 cargo build --release

🖥️ For Server:

 cd server
 mvn clean package -DskipTests=true

🌐 For Proctor

cd proctor
bun install
# run live
bun run dev
# build to dist/
bun run build

👥 Team

Supervisors 🧭 - Thomas Stütz Github, Christian Aberger Github

Scrum Master 🌀 - Jakob Huemer-Fistelberger Github

Developer 💻 - Eldin Beganovic Github

Developer 💻 - Gregor Geigenberger Github

Developer 💻 - Clemens Zangenfeind Github

📄 License

📝 MIT License

📘 Additional Documentation

Also checkout the docs or the guide

In the future our web interface proctor

For Developer Guides check the project_guide