Documentation Index

Fetch the complete documentation index at: https://docs.pyqdeck.in/llms.txt

Use this file to discover all available pages before exploring further.

​

Authentication & Error Handling Documentation

​

🔑 Authentication (Clerk)

​

1. Provider Configuration

• Theme: We use the shadcn theme for Clerk components to match our application’s aesthetic.
• Root Layout Integration:
  // src/app/layout.jsx
  <ClerkProvider>
    <TooltipProvider>
      <Header />
      <main className="flex-1 pt-16">{children}</main>
    </TooltipProvider>
  </ClerkProvider>
  

​

2. Middleware & Route Protection

• File: src/middleware.js
• Logic: We use clerkMiddleware() to handle session validation. All routes except static assets and Next.js internals are intercepted.
• Matcher: Configured to skip static files (images, fonts, etc.) but run for all API routes and application pages.

​

3. Authentication Pages

• Sign In: /sign-in (src/app/sign-in/[[...sign-in]]/page.jsx)
• Sign Up: /sign-up (src/app/sign-up/[[...sign-up]]/page.jsx)

​

4. Authenticated API Requests

• Hook: useApi (src/hooks/use-api.js)
• How it works:
  • It retrieves the Clerk JWT token using getToken().
  • It injects this token into the Authorization header as a Bearer token.
  • The backend verifies this token to identify the user and their permissions.

​

🛡️ Error Handling & Tracking

​

1. Sentry Integration (Planned/Configured)

• Client-side Errors: Caught by Sentry’s browser SDK.
• Server-side Errors: Captured during SSR or in Middleware.
• API Errors: The useApi hook and generated API client handle axios errors. Any 4xx or 5xx responses from the backend are processed, and critical failures are reported to Sentry.

​

2. User Feedback (Sonner)

• Success: toast.success("Saved successfully")
• Error: toast.error("Something went wrong")

​

🛠️ Key Technologies Used

​

🔗 Useful Links

• Clerk Documentation
• Next.js Middleware Guide
• Sentry Next.js SDK