2026-09-04 11:28:59 +01:00
|
|
|
# Project Manager — web
|
2026-09-03 18:12:31 +01:00
|
|
|
|
|
|
|
|
Vue 3 + TypeScript + Vite PWA. Talks to the REST API in the parent directory.
|
|
|
|
|
|
2026-09-04 13:37:17 +01:00
|
|
|
## Develop
|
2026-09-03 18:12:31 +01:00
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
npm install
|
|
|
|
|
npm run dev # http://localhost:5173
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The dev server proxies `/api` to `http://localhost:8080` (the Dockerised API —
|
|
|
|
|
run `docker compose up -d` in the parent directory first). Override the target
|
|
|
|
|
with `VITE_PROXY_TARGET`, or point the app at a different API entirely with
|
|
|
|
|
`VITE_API_BASE_URL` (see [.env.example](.env.example)).
|
|
|
|
|
|
|
|
|
|
## Build
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
npm run build # type-checks, then emits dist/
|
|
|
|
|
npm run preview
|
|
|
|
|
```
|
|
|
|
|
|
2026-09-04 13:37:17 +01:00
|
|
|
The parent `Dockerfile` runs this build in a Node stage and copies `dist/` into
|
|
|
|
|
the PHP image's `public/`, so the `app` container serves the compiled SPA at `/`.
|
|
|
|
|
There is no separate frontend container — a production image is `docker compose
|
|
|
|
|
build app` from the parent directory.
|
|
|
|
|
|
2026-09-03 18:12:31 +01:00
|
|
|
## Layout
|
|
|
|
|
|
|
|
|
|
```
|
2026-09-03 18:59:51 +01:00
|
|
|
src/main.ts App bootstrap; resolves the stored session before mount
|
|
|
|
|
src/router/index.ts Routes + guard (redirects to /login when unauthenticated)
|
|
|
|
|
src/stores/auth.ts Pinia store: token in localStorage, register/login/fetchMe
|
2026-09-04 11:28:59 +01:00
|
|
|
src/stores/projects.ts Pinia store: the user's projects (fetch + create)
|
2026-09-04 13:37:17 +01:00
|
|
|
src/stores/cards.ts Pinia store: one project's cards (CRUD + reorderColumn)
|
2026-09-03 18:59:51 +01:00
|
|
|
src/lib/api.ts fetch wrapper, bearer token, typed ApiError
|
2026-09-04 13:55:31 +01:00
|
|
|
src/components/AppSidebar.vue left nav: Dashboard link, divider, project list + new-project form
|
2026-09-04 13:37:17 +01:00
|
|
|
src/components/CardRow.vue editable text + status chip + delete, one card
|
|
|
|
|
src/components/KanbanCard.vue small draggable card for the board columns
|
2026-09-04 13:55:31 +01:00
|
|
|
src/views/ DashboardView, ProjectView, LoginView, RegisterView,
|
2026-09-03 20:04:49 +01:00
|
|
|
ProfileView, VerifyEmailView
|
2026-09-03 18:12:31 +01:00
|
|
|
```
|
|
|
|
|
|
2026-09-04 13:55:31 +01:00
|
|
|
## Layout
|
|
|
|
|
|
|
|
|
|
Signed-in "app" routes (`meta.requiresAuth`) render inside a persistent shell:
|
|
|
|
|
the top bar, then a left **sidebar** (`AppSidebar.vue`) beside the routed view.
|
|
|
|
|
The sidebar stays mounted across navigation — it holds a **Dashboard** link, a
|
|
|
|
|
divider, the project list, and a compact new-project form (creating one jumps to
|
|
|
|
|
it). The current page is highlighted via RouterLink's `active-class`.
|
|
|
|
|
`<RouterView :key="route.path">` remounts the view on every path change so
|
|
|
|
|
sidebar → project → project navigation always does a fresh load.
|
|
|
|
|
|
2026-09-04 14:02:47 +01:00
|
|
|
`/` redirects to `/dashboard` (`DashboardView.vue`), a full-width grid of
|
|
|
|
|
project cards — each shows the project name and, under a **New** heading, its
|
|
|
|
|
inbox cards (`status_id === null`), fetched per project. Signed-out routes
|
|
|
|
|
(`/login`, `/register`, `/verify-email`) render without the sidebar.
|
2026-09-04 13:55:31 +01:00
|
|
|
|
2026-09-04 11:28:59 +01:00
|
|
|
## Project detail
|
2026-09-03 18:59:51 +01:00
|
|
|
|
2026-09-04 13:37:17 +01:00
|
|
|
`/projects/:id` shows one project. It renders on a **full-width** layout (the
|
|
|
|
|
route sets `meta.wide`, which widens `.app__main` in `App.vue`). The title and
|
|
|
|
|
description are inline-editable (saved on blur via `PATCH /api/projects/:id`; the
|
|
|
|
|
description shows an "Add a description" placeholder when empty). A **Manage**
|
|
|
|
|
menu (top right) has a **Delete project** action that opens a confirmation modal;
|
2026-09-04 13:55:31 +01:00
|
|
|
confirming calls `DELETE /api/projects/:id` and returns to the dashboard.
|
2026-09-03 19:10:31 +01:00
|
|
|
|
2026-09-04 13:37:17 +01:00
|
|
|
Below the header are two tabs (local `activeTab` state, `v-show` so both stay
|
|
|
|
|
mounted):
|
|
|
|
|
|
|
|
|
|
### All tasks
|
|
|
|
|
|
|
|
|
|
The flat card list, **sorted by name (case-insensitive)** via a `sortedCards`
|
|
|
|
|
computed — there is no manual order here. Each row is an inline-editable text
|
|
|
|
|
field (saved on blur), a status chip (`card.status.name` or "No status"), and a
|
|
|
|
|
delete button.
|
|
|
|
|
|
|
|
|
|
### Kanban
|
|
|
|
|
|
|
|
|
|
Columns, left to right: **Inbox** (cards with no status) then each project
|
|
|
|
|
status in `position` order. `board` is derived from `cards.cards` + the
|
|
|
|
|
project's statuses and rebuilt by a `watch` whenever either changes.
|
|
|
|
|
|
|
|
|
|
Every drop — whether reordering within a column (`moved`) or dragging in from
|
|
|
|
|
another (`added`) — calls `cards.reorderColumn(column.statusId, ids)` →
|
|
|
|
|
`PUT /api/projects/:id/cards/order` with `{ status_id, card_ids }`. The server
|
|
|
|
|
re-parents any moved-in card, re-packs the source column, and returns the whole
|
|
|
|
|
project's cards, which replaces local state; on failure the board reloads.
|
|
|
|
|
|
|
|
|
|
The Inbox column has a small name + **Add** form at the bottom (`cards.add`);
|
|
|
|
|
new cards have no status, so they land straight in it.
|
2026-09-03 18:59:51 +01:00
|
|
|
|
2026-09-03 18:12:31 +01:00
|
|
|
## Auth flow
|
|
|
|
|
|
2026-09-04 10:29:13 +01:00
|
|
|
- The token from register / login / opening a magic link is kept in
|
|
|
|
|
`localStorage` and sent as `Authorization: Bearer …`.
|
2026-09-03 18:12:31 +01:00
|
|
|
- On load, `fetchMe()` validates the stored token via `GET /api/me`; a failure
|
|
|
|
|
clears it.
|
|
|
|
|
- Routes with `meta.requiresAuth` redirect to `/login` (preserving the intended
|
|
|
|
|
path) when there is no authenticated user.
|
|
|
|
|
- Registration signs the user in immediately; the new account's email is
|
2026-09-03 20:04:49 +01:00
|
|
|
unverified (`user.email_verified === false`). The header shows a "verify
|
|
|
|
|
email" badge linking to `/profile`.
|
2026-09-04 10:29:13 +01:00
|
|
|
- `LoginView` defaults to **magic link**: an email field and a "Log in with
|
|
|
|
|
email" button that calls `POST /api/auth/magic-link`. A "Log in with password"
|
|
|
|
|
link reveals the password field and switches the button to a plain "Log in"
|
|
|
|
|
(`POST /api/auth/login`); the link then reads "Get a magic link" to switch
|
|
|
|
|
back.
|
2026-09-03 20:04:49 +01:00
|
|
|
|
|
|
|
|
## Email verification & profile
|
|
|
|
|
|
2026-09-04 10:29:13 +01:00
|
|
|
- `/verify-email?token=…` is the target for every magic link (verification,
|
|
|
|
|
passwordless login, email change). `VerifyEmailView` POSTs the token to the
|
|
|
|
|
API, which returns a session — so opening any link both verifies the address
|
2026-09-04 11:28:59 +01:00
|
|
|
and signs the user in — then redirects to the projects.
|
2026-09-03 20:04:49 +01:00
|
|
|
- `/profile` (`ProfileView`) shows the address and verification status. When
|
|
|
|
|
unverified it offers a **Resend** button; the API throttles to once a minute,
|
|
|
|
|
and the button shows a live countdown (driven by `retry_after`, and by `429`
|
|
|
|
|
responses).
|
|
|
|
|
- The **Change email** form takes the new address and the current password.
|
|
|
|
|
On success the API has emailed a confirmation link to the *new* address and
|
|
|
|
|
set `user.pending_email`; the change only lands when that link is opened. The
|
|
|
|
|
resend and change actions share the one-minute cooldown.
|