Skip to content
JiraVision

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

  1. Go to /signup and submit the form. It posts to /api/auth/register.
  2. Sign in at /login. That posts to /api/auth/login and sets the jv_session cookie.
  3. Confirm the session with GET /api/user/current — it returns the signed-in user row.

2. Set your profile

  1. Open /dashboard/settings.
  2. Fill in Profile (name, role, timezone) — it saves through PATCH /api/user/profile.
  3. Upload an avatar if you want one; it posts to /api/user/avatar/upload and is stored in object storage.
  4. Leave Notifications on so the bell in the top bar receives events.

3. Add your team

  1. Open /dashboard/team.
  2. Add a member. The form posts to /api/team/members and creates a notification for that person.
  3. 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

  1. Open /dashboard/tasks and create a task: title, description, status, priority, story points, assignee, due date and tags.
  2. Switch between grid and list view with the toggle in the toolbar; filters and search are applied server-side through GET /api/tasks.
  3. 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

  1. Open /dashboard/sprints and create a sprint with a start and end date.
  2. Assign tasks to it (sprintId on the task) from /dashboard/backlog.
  3. 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

  1. /dashboard/team-wellbeing for anonymous check-ins and workload.
  2. /dashboard/ethical-metrics for the documented team-level indicators and their formulas.
  3. /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.