Skip to content
ConversionIQ Docs

ConversionIQ (app.conversioniq.ai)

Route

Section titled “Route”
  • Path: /
  • Parent: ../README.md
  • Children:
    • sign-in-sign-up.md
    • 404.md
    • 501.md

Purpose (business goal)

Section titled “Purpose (business goal)”

Provide the platform’s main entry point and route users to authentication and authorized application areas.

User roles & permissions

Section titled “User roles & permissions”
  • Roles: all (unauthenticated + authenticated)
  • Permissions: authentication gate is enforced; authorized areas require role/permission checks.
  • Reference: Roles & Permissions Model

Layout structure

Section titled “Layout structure”
  • Public shell (minimal UI) → auth entry
    • Sign in / Sign up
    • Verify your identity (verification code entry)
  • After auth (MVP):
    • Route user into the Get Started fullscreen overlay (Get Started – Stepper (3 steps)).
    • If the overlay is dismissed/closed, route the user to Account → Dashboard (Account – Dashboard).
    • Closing/dismissing the overlay does not complete onboarding; it will appear again on the next authenticated entry until onboarding is complete.
    • Onboarding is considered complete only after the user completes Step 3: Train ConversionIQ AI; only then should users bypass the overlay and land on Account → Dashboard by default.

Components used

Section titled “Components used”

TBD (route shell, auth CTA)

States

Section titled “States”
  • Empty: N/A
  • Loading: session check / redirect
  • Error: auth service unavailable
  • Complete: renders auth entry flow (sign-in/sign-up → verify identity)

Business logic (high-level)

Section titled “Business logic (high-level)”
  • Session detection and redirect logic.
  • Authentication entry flow delegates to sign-in-sign-up.md:
    • MVP: sign-in is email-only.
    • Verification is required for both sign-in and sign-up.
  • Workspace selection/restore behavior.
  • Onboarding gate (MVP):
    • Immediately after auth, users enter Get Started overlay until the user completes Step 3: Train ConversionIQ AI.

Domain refs:

API dependencies

Section titled “API dependencies”
  • GET /auth/session (TBD)
  • POST /auth/sign-in (TBD)
  • POST /auth/sign-up (TBD)
  • POST /auth/verify (TBD)

Enterprise constraints

Section titled “Enterprise constraints”
  • SSO readiness (future)
  • Audit auth events

Edge cases

Section titled “Edge cases”
  • Session exists but workspace membership revoked
  • Multiple orgs/workspaces for a user

Security & compliance considerations

Section titled “Security & compliance considerations”
  • Avoid open redirects
  • Secure session cookies/tokens

Reference: Security & Compliance

Analytics events (if applicable)

Section titled “Analytics events (if applicable)”
  • auth.sign_in.success
  • auth.sign_in.failure

Reference: Analytics Events (MVP)