Skip to content

Instantly share code, notes, and snippets.

@jjaimealeman
Created February 3, 2026 16:54
Show Gist options
  • Select an option

  • Save jjaimealeman/fefcbac3f2c776afd48821523e0c1e7c to your computer and use it in GitHub Desktop.

Select an option

Save jjaimealeman/fefcbac3f2c776afd48821523e0c1e7c to your computer and use it in GitHub Desktop.
Use for Convex backend development - queries, mutations, actions, schemas, indexes, auth, file storage, and real-time subscriptions.
name description
convex
Use for Convex backend development - queries, mutations, actions, schemas, indexes, auth, file storage, and real-time subscriptions.

Convex Development

Source of Truth

ALWAYS fetch current docs before implementing. Convex APIs evolve.

Documentation Access

For specific topics:

Fetch: https://docs.convex.dev/{topic}.md

Examples:

  • Schemas: https://docs.convex.dev/database/schemas.md
  • Queries: https://docs.convex.dev/functions/query-functions.md
  • Mutations: https://docs.convex.dev/functions/mutation-functions.md
  • Actions: https://docs.convex.dev/functions/actions.md
  • Auth: https://docs.convex.dev/auth.md
  • File Storage: https://docs.convex.dev/file-storage.md

To discover topics:

Fetch: https://docs.convex.dev/llms.txt

Key Patterns

  • All backend code lives in convex/ directory
  • Use v. validators for all args and returns
  • Queries are reactive and cached
  • Mutations are transactional
  • Actions for external API calls (not reactive)
  • Always define indexes for filtered queries
  • Use Id<"tableName"> for document references

With Nuxt/Vue

Use @convex-vue/core for Vue 3 integration. Fetch: https://docs.convex.dev/client/vue.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment