add stackAuthComponent to convex readme by BilalG1 · Pull Request #999 · stack-auth/stack-auth

BilalG1 · 2025-11-04T21:18:00Z

Summary by CodeRabbit

Documentation
- Added comprehensive Convex integration setup guide with configuration examples for Vanilla JavaScript, React, and Next.js frameworks
- Included Stack Auth integration documentation featuring step-by-step client configuration instructions and practical implementation examples for production deployments

vercel · 2025-11-04T21:18:06Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
stack-backend	Ready	Preview	Comment	Nov 4, 2025 9:26pm
stack-dashboard	Ready	Preview	Comment	Nov 4, 2025 9:26pm
stack-demo	Ready	Preview	Comment	Nov 4, 2025 9:26pm
stack-docs	Ready	Preview	Comment	Nov 4, 2025 9:26pm

coderabbitai · 2025-11-04T21:18:11Z

Walkthrough

Documentation update for the Convex integration component, adding configuration examples and guidance for setting up convex.config.ts with Stack Auth, along with client-side auth setup instructions for different framework variants.

Changes

Cohort / File(s)	Summary
Convex integration documentation `packages/template/src/integrations/convex/component/README.md`	Added code example for `convex/convex.config.ts` using `defineApp` and `stackAuthComponent`; added framework-specific import guidance for Vanilla JS, React, and Next.js; added instructions and example code for updating Convex client to use Stack Auth

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Verify documentation clarity and accuracy of code examples
Confirm framework variant guidance is comprehensive and correct

Possibly related PRs

stack-auth/stack-auth#953: Updates Convex integration documentation for client-side auth setup (getConvexClientAuth/getConvexHttpClientAuth) in similar README context

Poem

🐰 A config tale in markdown's glow,
With Convex paths now set to flow,
Auth components, guides so clear—
Stack reaches docs without a tear! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description only contains the template HTML comment reminder to read CONTRIBUTING.md with no substantive content, details about the changes, or explanation of the rationale.	Add a meaningful description explaining what changes are being made, why they're needed, and what the stackAuthComponent addition enables for Convex users.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'add stackAuthComponent to convex readme' is clear, concise, and directly summarizes the main change—adding stackAuthComponent documentation to the Convex README.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch update-convex-readme

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1e36f0e and f942bcf.

📒 Files selected for processing (1)

packages/template/src/integrations/convex/component/README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)

GitHub Check: all-good
GitHub Check: check_prisma_migrations (22.x)
GitHub Check: lint_and_build (latest)
GitHub Check: restart-dev-and-test-with-custom-base-port
GitHub Check: build (22.x)
GitHub Check: setup-tests
GitHub Check: restart-dev-and-test
GitHub Check: build (22.x)
GitHub Check: docker
GitHub Check: build (22.x)
GitHub Check: Security Check

🔇 Additional comments (1)

packages/template/src/integrations/convex/component/README.md (1)

31-44: Well-structured configuration guide.

The new convex.config.ts section integrates cleanly with the existing documentation. The framework-variant pattern (Vanilla JS, React, Next.js) is consistent with the earlier auth.config.ts section, and the inline comments make it clear which import to use for each framework. The configuration structure using defineApp() and app.use(stackAuthComponent) is straightforward.

Please verify that the import paths (@stackframe/js/convex.config, @stackframe/react/convex.config, @stackframe/stack/convex.config) are correct and that these named/default exports exist in the published packages.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

greptile-apps

Greptile Overview

Greptile Summary

Added missing setup instructions for convex.config.ts configuration to the Convex integration README.

Documented how to import and use stackAuthComponent from all three SDK packages (@stackframe/js, @stackframe/react, @stackframe/stack)
Provides clear code example showing how to define a Convex app and register the Stack Auth component using app.use()
Fills a critical documentation gap between the auth.config.ts setup and the client configuration steps
Matches the existing implementation pattern used in the working example at examples/convex/convex/convex.config.ts

Confidence Score: 5/5

This PR is safe to merge with no concerns
The change is a pure documentation addition that fills a gap in setup instructions. The code examples match the verified exports in all three SDK packages and align with the working example in the codebase. No code logic is modified.
No files require special attention

Important Files Changed

File Analysis

Filename	Score	Overview
packages/template/src/integrations/convex/component/README.md	5/5	Added setup instructions for `convex.config.ts` with correct imports for all three SDK packages (js, react, stack)

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Readme as README.md
    participant Conv as convex.config.ts
    participant App as Convex App
    participant Stack as Stack Auth Component

    Dev->>Readme: Read setup instructions
    Readme-->>Dev: Shows auth.config.ts step
    Readme-->>Dev: Shows convex.config.ts step (NEW)
    Dev->>Conv: Create/update convex.config.ts
    Dev->>Conv: Import stackAuthComponent from SDK
    Dev->>Conv: Define app with defineApp()
    Dev->>Conv: Register component with app.use()
    Conv->>App: Export configured app
    App->>Stack: Loads Stack Auth component
    Stack-->>App: Provides auth functionality

_{1 file reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

add stackAuthComponent to convex readme

2648e3c

Merge branch 'dev' into update-convex-readme

f942bcf

github-actions bot assigned BilalG1 Nov 4, 2025

greptile-apps bot reviewed Nov 4, 2025

View reviewed changes

N2D4 merged commit e824e8c into dev Nov 5, 2025
20 of 22 checks passed

N2D4 deleted the update-convex-readme branch November 5, 2025 06:13

coderabbitai bot mentioned this pull request Nov 5, 2025

add stackAuthComponent to convex readme #1001

Closed

This was referenced Nov 25, 2025

Fix convex bundle bug #1028

Closed

convex fix auth config bug #1031

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add stackAuthComponent to convex readme#999

add stackAuthComponent to convex readme#999
N2D4 merged 2 commits intodevfrom
update-convex-readme

BilalG1 commented Nov 4, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Nov 4, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Nov 4, 2025 •

edited

Loading

Uh oh!

greptile-apps bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

BilalG1 commented Nov 4, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Pre-merge checks and finishing touches

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Greptile Overview

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Sequence Diagram

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

BilalG1 commented Nov 4, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Nov 4, 2025 •

edited

Loading

coderabbitai bot commented Nov 4, 2025 •

edited

Loading