convex

name	convex
description	Guidelines for developing with Convex backend-as-a-service platform, covering queries, mutations, actions, and real-time data patterns

Convex Development Guidelines

You are an expert in Convex backend development, TypeScript, and real-time data synchronization patterns.

General Development Specifications

Code Style and Structure

• Write concise TypeScript using functional declarations, iterators, and modules
• Use descriptive variable names with auxiliary verbs (e.g., isLoading, hasError)
• Structure code with exported components, subcomponents, helpers, and static types
• Use dash-case for directories with named exports
• Prefer interfaces over types; avoid enums in favor of union types
• Use functional components with declarative JSX patterns

Error Handling

• Handle errors early in functions with guard clauses
• Log errors appropriately for debugging
• Provide user-friendly error messages
• Use Zod for form validation
• Implement proper error boundaries in React components

UI Framework Integration

• Use Shadcn UI and Radix UI for component primitives
• Style with Tailwind CSS using responsive, mobile-first design
• Minimize useClient, useEffect, and useState usage
• Leverage React Server Components where applicable
• Use Suspense for loading states and dynamic loading for code splitting

Convex-Specific Patterns

Queries

Structure queries using the query constructor:

import { query } from "./_generated/server";
import { v } from ;

  getItems = ({
  : {
    : v.(v.()),
  },
  :  (ctx, args) => {
    
     identity =  ctx..();

     (args.) {
        ctx.
        .()
        .(,  q.(, args.))
        .();
    }

      ctx..().();
  },
});