Quick start
From an empty account to a planned sprint in about ten minutes.
Quick start
This walkthrough uses only routes that exist in the app. Follow it top to bottom.
1. Create your account
- Go to /signup and submit the form. It posts to /api/auth/register.
- Sign in at /login. That posts to /api/auth/login and sets the jv_session cookie.
- Confirm the session with GET /api/user/current — it returns the signed-in user row.
2. Set your profile
- Open /dashboard/settings.
- Fill in Profile (name, role, timezone) — it saves through PATCH /api/user/profile.
- Upload an avatar if you want one; it posts to /api/user/avatar/upload and is stored in object storage.
- Leave Notifications on so the bell in the top bar receives events.
3. Add your team
- Open /dashboard/team.
- Add a member. The form posts to /api/team/members and creates a notification for that person.
- Promote someone to admin with the role control on their row — it patches /api/team/members/<id>/role and writes an entry to the role audit log.
4. Create work
- Open /dashboard/tasks and create a task: title, description, status, priority, story points, assignee, due date and tags.
- Switch between grid and list view with the toggle in the toolbar; filters and search are applied server-side through GET /api/tasks.
- Drag the same task on /dashboard/kanban. A drop between columns sends PUT /api/tasks/<id> with the new status; dropping a day's occurrence sends PATCH /api/task-instances/<id> instead.
5. Plan a sprint
- Open /dashboard/sprints and create a sprint with a start and end date.
- Assign tasks to it (sprintId on the task) from /dashboard/backlog.
- Open /dashboard/ai-scrum-master to generate a capacity-aware draft plan. Nothing is written to your board until you approve the draft.
6. Check the signals
- /dashboard/team-wellbeing for anonymous check-ins and workload.
- /dashboard/ethical-metrics for the documented team-level indicators and their formulas.
- /dashboard/reports to build a report, then export it as CSV or JSON.
Next
- Read the notifications doc to understand the bell and the SSE feed.
- Read the API reference if you want to script any of the above.