clean up
This commit is contained in:
12
README.md
12
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).
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 398 B |
Binary file not shown.
|
Before Width: | Height: | Size: 770 B |
@@ -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.
|
||||
|
||||
@@ -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
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user