GitXplorerGitXplorer
P

steamr

public
1 stars
0 forks
0 issues

Commits

List of commits on branch main.
Verified
1211e204d50ba9e72413948c3287c5ff32437453

feat(readme): fix typos

PPascalHonegger committed 3 years ago
Unverified
b3fe0286e93a40cd56c61c858138d059b294b219

feat(profile): Fix wrong Constraint in layout

mmjossdev committed 3 years ago
Unverified
6f16aa844d1c3a3d380b50e77097c29cdc329302

feat(entry): trim entered text before storing id

mmjossdev committed 3 years ago
Unverified
27043b0c164c1c40736a42aa9217c6f7153c07ca

feat(readme): add screenshots

PPascalHonegger committed 3 years ago
Unverified
b0c47ecb5fb90a7713f04c36eba607c57369751e

feat(entry): trim input

mmjossdev committed 3 years ago
Unverified
80312a1beefeb7e268ea2588a3f3b7c082477c0f

feat(profile): Display banner of active game

mmjossdev committed 3 years ago

README

The README file for this repository.

Steamr

Idee

Steamr ist eine App, die einem erlaubt diverse öffentlich einsehbare Daten von einem Steam Community Profil anzuzeigen. Dazu kann auf der Startseite eine Profil-ID eingegeben werden, woraufhin damit verbundene Daten geladen werden. Die angezeigten Profildaten sind öffentlich einsehbar, weshalb wir keinen API Schlüssel oder änhliches benötigen. Da das Eingeben einer ID mühsam ist, werden die früher eingegebenen IDs lokal gespeichert und zur Auswahl angezeigt.

Profil-ID eingabe

Eingabe der Steam ID als Text. Der "View Profile" Button ist deaktiviert, solange keine Eingabe erfolgt ist. Unterhalb der Eingabe werden vorherige Eingaben dargestellt, welche bei einem Klick ins Input übernommen werden. Vergangene Inputs können über den Mülleimer gelöscht werden.

Profil-Ansicht

Zuerst wird ein Load-Indicator angezeigt. Falls keine Daten geladen werden konnent, wird ein Fehler angezeigt. In der Profil-Ansicht werden einige Daten des Benutzer dargestellt, falls diese vorhanden sind. Die Beschreibung und der Spiele-Titel können HTML enthalten und werden dementsprechend verarbeitet.

Einstellungen

Benutzer haben die Möglichkeit einstellungen von Steamr zu verwalten. Die einzige Einstellung ist das Farbschema der App, welches explizit auf Light oder Dark gestellt werden kann.

Screenshots

Light Theme Dark Theme
Start Light Start Dark
Settings Light Settings Dark
Profile Light Profile Dark

Weiteres

Intent Filter

Zusätzlich kann ein Benutzer im Browser ein Steam-Profil öffnen und die URL mit der Steamr App öffnen.

Mehrsprachigkeit

Wir unterstützen Englisch und Deutsch (CH).

Light- und Darktheme

Wir haben ein Light- und Darktheme, wobei das Farbschema an Steam angelehnt ist.

Kotlin

Technisch verwenden wir ViewBindings und ausschliesslich Kotlin. Ebenfalls haben wir unsere Gradle files von Groovy nach Kotlin Script migriert und verwenden die neusten Versionen aller dependencies.

Tests

Wir haben versucht sinnvolle Unit- und Android-Tests zu schreiben. Da unsere grösste Logik in der Startseite und im Parsen von XML liegt sind diese zwei Komponenten getestet. Wir haben auch eine kleine CI-Pipeline in GitHub konfiguriert, welche unsere Unit-Tests automatisch ausführt.

Punkte

Wir versuchen zu zweit folgende Punkte für das Testat zu erreichen:

Feature Punkte
Kotlin 6P
Profil-ID Eingabe 2P
Profil-Ansicht 2P
Einstellungen 1P
Verwendung Preferences 1P
Englisch & Deutsch 1P
Light- und Dark-Theme 1P
Anbindung Steam API 2P
Sinnvolle Unit-Tests 1P
Total 17P