convex-component-authoring

Create and publish self-contained Convex components with standard project structure.

Updated Dec 25, 2025
One-click install
npx skills add https://github.com/benfwalla/things-to-be-happy-about --skill convex-component-authoring-benfwalla
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-component-authoring
Source: https://github.com/benfwalla/things-to-be-happy-about/tree/main/.claude/skills/convex-component-authoring
Command: npx skills add https://github.com/benfwalla/things-to-be-happy-about --skill convex-component-authoring-benfwalla

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex component authors need to create self-contained, reusable Convex components that are properly isolated and easily consumable across apps.

Core Features & Use Cases

  • Provides a standard project skeleton (package.json, convex.config.ts, tsconfig.json) and a clear export surface.
  • Enables packaging of schema, functions, and types into a single reusable component that can be versioned and published.
  • Use Case: teams can distribute UI blocks and backend logic across multiple Convex apps as independent components.

Quick Start

Initialize a new convex component project using the described structure, implement the schema and functions, and publish the package.

Frequently Asked Questions about convex-component-authoring

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build reusable Convex components for distribution across multiple apps?

To build reusable Convex components, package your database schema, functions, and types into a self-contained module with a standard project skeleton including package.json, convex.config.ts, and tsconfig.json. This structure ensures proper isolation and easy consumption across apps.

What files are required to publish a Convex component?

Publishing a Convex component requires a standard project skeleton containing package.json, convex.config.ts, and tsconfig.json. You also need a clear exports surface to define how consuming apps interact with your packaged schema, functions, and types.

Can I include optional references or assets in a Convex component?

Yes, when authoring a Convex component, you can include optional references, scripts, or assets as needed alongside the core schema and functions. These are packaged within the self-contained module structure for versioned distribution.

How do I share backend logic and UI blocks across different Convex apps?

You can share backend logic and UI blocks by creating self-contained, reusable Convex components. By packaging the logic into an independent component with a clear export surface, teams can distribute and consume it across multiple Convex apps.

What is the best way to isolate and version Convex backend modules?

The best way to isolate and version Convex backend modules is to package them as reusable components using a standard structure with package.json and convex.config.ts. This enables self-contained, versioned publishing for independent consumption.