From 411d7568a7521f9773e784d85031e2637fcdbf93 Mon Sep 17 00:00:00 2001 From: cpu Date: Fri, 9 May 2025 23:40:18 +0200 Subject: [PATCH] clean up --- README.md | 12 ++---------- assets/favicon-16x16.png | Bin 398 -> 0 bytes assets/favicon-32x32.png | Bin 770 -> 0 bytes docs/architecture.md | 7 +++++++ docs/deployment.md | 10 +++++++++- 5 files changed, 18 insertions(+), 11 deletions(-) delete mode 100644 assets/favicon-16x16.png delete mode 100644 assets/favicon-32x32.png diff --git a/README.md b/README.md index 85e7796..405756a 100644 --- a/README.md +++ b/README.md @@ -51,13 +51,13 @@ For an enhanced tactile experience, Nexus Timer supports Smart Buttons based on * If all players pause their timers, automatically reverts to Normal Mode. * Main button: "Stop All Timers" (pauses all, returns to Normal Mode) or "Start All Timers" (resumes all in this mode). Can also be triggered by "Global Stop/Pause All" hotkey. * **Player Management:** - * Add, edit, and delete players (2-7 players). + * Add, edit, and delete players. * Use device camera (access via browser API) or default avatars for the player's picture. * Set initial timer values per player (Default: 60:00). * Assign unique "Pass Turn / My Pause" hotkeys (single keypresses). E.g.: Use the Player's 1 "single click" action to insert the key. * Assign the "Global Stop/Pause All" hotkey (single keypresses). E.g.: Use the Player's 3 "long press" action to insert the key. * Assign the "Run All Timers" hotkey (single keypresses). E.g.: Use the Player's 3 "double click" action to insert the key. - * Re-order players (drag-and-drop planned), reverse, shuffle. + * Re-order players, reverse, shuffle. * **Intuitive Controls:** * **Swipe Up:** (On the Next Player's area). Primary gesture for passing turns (Normal Mode). * **On-Screen Taps:** (On the Current Player's area). For pausing/resuming timers contextually. @@ -71,14 +71,6 @@ For an enhanced tactile experience, Nexus Timer supports Smart Buttons based on * **Persistence:** Player setups, timer states, and settings are saved locally using browser Local Storage. * **Global Reset:** "Reset Game" button restores all timers to initial values and resets game state. -## UI/UX Considerations - -* **Minimalist Design:** Focus on clarity and ease of use. Avoid clutter. -* **Large, Clear Timers:** Timers should be easily readable at a glance. -* **Color Coding:** Use color to indicate timer state (e.g., green for running, red for negative time, grey for skipped). -* **Responsive Layout:** The UI should adapt to different (mobile phone) screen sizes. -* **Touch-Friendly:** Buttons and interactive elements should be large enough for easy tapping. - ### For Developer Setup, see [Developer Setup Guide](docs/development.md). ### For Deployment Setup, see [Deployment Setup Guide](docs/deployment.md). ### For Architecture Docs, see [Architecture](docs/architecture.md). diff --git a/assets/favicon-16x16.png b/assets/favicon-16x16.png deleted file mode 100644 index 8d52034c62a6445ee292243a68123ff04849b538..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 398 zcmV;90df9`P)Px$NJ&INR5(v#l$-Omj){S>nt_3Vje#`q>mS4aRz`(6?|zb@8D`ZlkOBX(SuDZD z#2~@V2$uQ>!v7)o@#lXGpMN2=U>IO1#==l%!O37C%7WEHG21^g9DVi&E{9@(t_U;3 zEEgVzwPx%yh%hsR9HvVS4n6SVHkb?WSXT(8a39o#uD+Ol2SxOD;A+r>cLj*#a$HbLA-hp zYeNrWy%j_#7>b}?S~nDmT32XQirOLsal05}8^t7=t%;dtMrI}%YiXLyq)haKVK#o= z`@Z+Rex zz@@GHzY^hj`|U8?{*)|f@^XPiM=;57U_?wQcv*&bSwIo-Q|*|LIVnQQ`OT7uDi3qYs)(&bLz z?2C9V9A!;7+o&dc2`)66q+iE}Vz~J+sUCsOIs*bPQf~fa6GpK+6krd@tkFQJmc1`-$&aez6xU0LjV8(07*qoM6N<$f;~H9 A6951J diff --git a/docs/architecture.md b/docs/architecture.md index bb7d7ce..c0a0e7a 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -1,3 +1,10 @@ +## UI/UX Considerations +* **Minimalist Design:** Focus on clarity and ease of use. Avoid clutter. +* **Large, Clear Timers:** Timers should be easily readable at a glance. +* **Color Coding:** Use color to indicate timer state (e.g., green for running, red for negative time, grey for skipped). +* **Responsive Layout:** The UI should adapt to different (mobile phone) screen sizes. +* **Touch-Friendly:** Buttons and interactive elements should be large enough for easy tapping. + ## Tech Stack * **HTML5:** For structuring the user interface. * **CSS3:** For styling and visual presentation, including animations. Consider a CSS framework like Tailwind CSS for rapid prototyping. diff --git a/docs/deployment.md b/docs/deployment.md index 7903c8a..e4f7890 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -9,6 +9,14 @@ Clone the repository git clone --depth 1 https://gitea.virtonline.eu/2HoursProject/nexus-timer.git cd nexus-timer ``` +If you will run the container on the docker network `traefik` find its IP subnet +```bash +docker network inspect traefik --format '{{(index .IPAM.Config 0).Subnet}}' +``` +Set the subnet in the `nginx.conf`. For example: +```bash +set_real_ip_from 172.22.0.0/16 +``` Build the docker image ```bash docker build -t virt-nexus-timer . @@ -25,7 +33,7 @@ View the example service definition: cat systemd/virt-nexus-timer.service ``` ### Create the systemd service -Use the editor to create or overwrite the service: +The editor opens to create or overwrite the service: ```bash sudo systemctl edit --force --full virt-nexus-timer.service ```