Turbo/lf9-pgg
9
0
Fork 0
Code Issues 1 Pull requests Projects 1 Releases Packages Wiki Activity Actions

Delete page "Technical-Handout"

mixel 2025-06-23 11:11:30 +02:00
parent a06a69b45c
commit 8677c11aba
1 changed files with 0 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
Technical-Handout.md

@ -1,38 +0,0 @@
# Technical Handout: API Description
## Introduction
PGG is a software solution designed to help teachers manage, track, and grade peer groups. This technical handout describes how the API handles requests from the Web UI.
## Why Do We Want to Implement APIs?
APIs are essential for separation of concerns and system modularity. Using APIs allows for flexibility — enabling multiple frontends to interact with the same backend, or vice versa. There are several architectural design patterns, such as MVC or MVVM, that promote the use of APIs.
Although we didn’t fully implement a specific design pattern due to the limited scope of the project, we followed modular principles that align with these architectures.
## Who Are the Users?
The primary users are teachers from schools who need to evaluate multiple peer groups efficiently.
## What User Problems Are We Solving and/or What Benefits Are We Creating?
The API addresses the need for clear labeling of groups, linking users to projects, and securing access via passwords. The goal is to make the grading process straightforward, secure, and accessible through the API.
## What Concrete Outcomes Do We Want to Achieve with These APIs?
We aim to provide a modular, secure, and scalable way to access database content from different frontends. The API abstracts the data layer and allows flexible integration with various user interfaces.
## How Do We Plan to Execute the API Program to Achieve That?
We are deploying the application as a statically linked Rust binary. This approach ensures performance, portability, and ease of deployment.
## What Is the Architectural Style and Why Did We Choose It (REST, SOAP, GraphQL, etc.)?
We chose to implement a RESTful API because it is a widely adopted, battle-tested standard. REST offers simplicity, scalability, and extensive documentation and tooling, making it an ideal choice for our use case.
## Summary / Conclusion
Overall, the application is a statically linked Rust project that exposes a REST API. The goal is to provide teachers with an easy, secure, and efficient way to access all relevant group data, including peer feedback and grading information.
<!-- ## References -->