qavion/qavion-time-tracker-assessment
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: sync project documentation

Browse Source
This commit is contained in:
Achim Rohn
2026-05-21 16:49:28 +02:00
parent d1d7cf5265
commit 9e6e71a87b
2 changed files with 20 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -6
View File
@@ -8,11 +8,11 @@ Docker Compose — Flyway for schema migrations — Tailwind CSS v4 — Biome 1.
## Features
- **Daily time entries** — date, project, duration (entered as h:mm), automatic cost from hourly rate
- **Weekly view** — navigate by ISO week; see total hours per day and a running week total
- **Daily time entries** — date, project, duration (entered as h:mm), automatic cost from hourly rate; entries can be created, edited, and deleted
- **Weekly view** — navigate by ISO week; see total hours per day, individual entries, and a running week total
- **Monthly view** — per-project summary with time and cost progress bars; red banner when a budget is exceeded
- **Project management** — create projects with time and cost budgets; set a project-level hourly rate or fall back to the user's default
- **Multi-user** — pick any seeded user from the dropdown; cost is calculated using that user's rate when no project rate is set
- **Project management** — create and edit projects with time and cost budgets; set a project-level hourly rate or fall back to the user's default
- **Multi-user** — pick any seeded user from the dropdown and edit that user's name/default rate; cost is calculated using that user's rate when no project rate is set
- **Soft budget enforcement** — entries always save; over-budget projects are highlighted with a warning banner and colored bars
## Quick start
@@ -68,7 +68,8 @@ Without mise:
```bash
# one-time setup
sudo apt install openjdk-21-jdk nodejs npm docker-compose-plugin
sudo apt install openjdk-21-jdk docker-compose-plugin
# Install Node 22 with your preferred Node version manager or distro-specific package.
export JAVA_HOME=/usr/lib/jvm/java-21-openjdk-amd64 # adjust if your JDK is elsewhere
npm --prefix frontend install
cp -n .env.example .env
@@ -99,7 +100,8 @@ for demo users and projects). Hibernate is set to `validate` — it never modifi
**API shape** — aggregation is done server-side via two dedicated endpoints:
`GET /api/reports/weekly?userId=&week=YYYY-Www` and `GET /api/reports/monthly?userId=&month=YYYY-MM`.
All other CRUD endpoints follow standard REST conventions under `/api/`.
Resource endpoints live under `/api/`: users can be listed and updated, projects can be listed,
created, and updated, and time entries can be listed by date range, created, updated, and deleted.
## Environment