jakobluca/fs2026-Frontend-Semesterarbeit
2
2
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: finalize README

Browse Source
This commit is contained in:
pengniklas 2026-06-01 16:43:23 +02:00
parent 861f850401
commit 4780557c67
1 changed files with 6 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -22,8 +22,6 @@ php serve.php
Then open `http://localhost:8000/` in your browser. PHP 8.0+ is required. Then open `http://localhost:8000/` in your browser. PHP 8.0+ is required.
> The `backend/data/` directory is not tracked in version control. PHP creates it automatically on first run.
--- ---
## How to play ## How to play
@ -85,9 +83,9 @@ tools/
| Drawing & Scoring | Canvas 2D API + Pointer Events | Native browser APIs; IoU scoring via 96×96 raster grid | | Drawing & Scoring | Canvas 2D API + Pointer Events | Native browser APIs; IoU scoring via 96×96 raster grid |
| Country data | GeoJSON outlines | Standard geospatial format, lightweight and precise | | Country data | GeoJSON outlines | Standard geospatial format, lightweight and precise |
| Backend | PHP 8.5 | Server-side REST API | | Backend | PHP 8.5 | Server-side REST API |
| Storage | JSON file (`lobbies.json`) | Dependency-free; no database server needed for this scope | | Storage | JSON file (lobbies.json) | Dependency-free; no database server needed for this scope |
| Testing | Node.js built-in test runner | Unit tests for IoU scoring algorithm (`scoring.test.mjs`) | | Testing | Node.js built-in test runner | Unit tests for IoU scoring algorithm (scoring.test.mjs) |
| Linting / Formatting | [Biome](https://biomejs.dev/) | Fast unified linter and formatter | | Linting / Formatting | Biome | Fast unified linter and formatter |
| Package Manager | npm | Dev-only dependency (Biome) | | Package Manager | npm | Dev-only dependency (Biome) |
--- ---
@ -96,19 +94,6 @@ tools/
| Name | Role | | Name | Role |
|---|---| |---|---|
| **Ivan Szabo** | Frontend development — built the complete initial frontend (all pages, scripts, styles) | | **Ivan Szabo** | Frontend development (initial/base: pages, scripts, styles...) |
| **Luca Jakob** | Frontend review; Backend development — PHP REST API and GeoJSON country outline data | | **Luca Jakob** | Frontend review; Backend development |
| **Niklas Peng** | Frontend improvements — accessibility, code quality, CSS consolidation, JSDoc, join lobby feature; Backend review | | **Niklas Peng** | Frontend improvements (accessibility, code quality, CSS consolidation, JSDoc...); Backend review |
---
## Self-Reflection
**Ivan Szabo:**
tbd
**Luca Jakob:**
tbd
**Niklas Peng:**
tbd