1# Local Convex Components
2 
3Read this file when the component should live inside the current app and does
4not need to be published as an npm package.
5 
6## When to Choose This
7 
8- The user wants the simplest path
9- The component only needs to work in this repo
10- The goal is extracting app logic into a cleaner boundary
11 
12## Default Layout
13 
14Use this structure unless the repo already has a clear alternative pattern:
15 
16```text
17convex/
18  convex.config.ts
19  components/
20    <name>/
21      convex.config.ts
22      schema.ts
23      <feature>.ts
24```
25 
26## Workflow Notes
27 
28- Define the component with `defineComponent("<name>")`
29- Install it from the app with `defineApp()` and `app.use(...)`
30- Keep auth, env access, public API wrappers, and HTTP route mounting in the app
31- Let the component own isolated tables and reusable backend workflows
32- Add app wrappers if clients need to call into the component
33 
34## Checklist
35 
36- [ ] Component is inside `convex/components/<name>/`
37- [ ] App installs it with `app.use(...)`
38- [ ] Component owns only its own tables
39- [ ] App wrappers handle client-facing calls when needed
40