Skip to content

Update README for WorkOS example: change WORKOS_REDIRECT_URI to point…#7802

Merged
LadyBluenotes merged 1 commit into
TanStack:mainfrom
soheilnikroo:docs/workos-readme-redirect-uri
Jul 12, 2026
Merged

Update README for WorkOS example: change WORKOS_REDIRECT_URI to point…#7802
LadyBluenotes merged 1 commit into
TanStack:mainfrom
soheilnikroo:docs/workos-readme-redirect-uri

Conversation

@soheilnikroo

@soheilnikroo soheilnikroo commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Updated examples/react/start-workos/README.md so the WORKOS_REDIRECT_URI env example uses http://localhost:3000/api/auth/callback, matching .env.example, the WorkOS dashboard setup step, and the registered callback route at /api/auth/callback. Verified the example builds successfully.

Resolve #7790

Summary by CodeRabbit

  • Documentation
    • Corrected the example app’s WorkOS redirect URI instructions to use the appropriate authentication callback URL.
    • Aligned the environment variable configuration with the setup steps described in the README.

@coderabbitai

coderabbitai Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 657f73d9-8373-48d4-8043-833799e99c69

📥 Commits

Reviewing files that changed from the base of the PR and between a3e24c3 and 2eb2cc3.

📒 Files selected for processing (1)
  • examples/react/start-workos/README.md

📝 Walkthrough

Walkthrough

The WorkOS example README updates WORKOS_REDIRECT_URI to use the application’s /api/auth/callback route.

Changes

WorkOS redirect URI

Layer / File(s) Summary
Update WorkOS redirect configuration
examples/react/start-workos/README.md
Changes the documented WORKOS_REDIRECT_URI from /callback to /api/auth/callback.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related issues

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the README update for the WorkOS example and its redirect URI change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@nx-cloud

nx-cloud Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

View your CI Pipeline Execution ↗ for commit 2eb2cc3

Command Status Duration Result
nx affected --targets=test:eslint,test:unit,tes... ✅ Succeeded 2m 24s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 2m 20s View ↗

☁️ Nx Cloud last updated this comment at 2026-07-12 13:16:58 UTC

@pkg-pr-new

pkg-pr-new Bot commented Jul 12, 2026

Copy link
Copy Markdown
More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@7802

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/@tanstack/eslint-plugin-router@7802

@tanstack/eslint-plugin-start

npm i https://pkg.pr.new/@tanstack/eslint-plugin-start@7802

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@7802

@tanstack/nitro-v2-vite-plugin

npm i https://pkg.pr.new/@tanstack/nitro-v2-vite-plugin@7802

@tanstack/react-router

npm i https://pkg.pr.new/@tanstack/react-router@7802

@tanstack/react-router-devtools

npm i https://pkg.pr.new/@tanstack/react-router-devtools@7802

@tanstack/react-router-ssr-query

npm i https://pkg.pr.new/@tanstack/react-router-ssr-query@7802

@tanstack/react-start

npm i https://pkg.pr.new/@tanstack/react-start@7802

@tanstack/react-start-client

npm i https://pkg.pr.new/@tanstack/react-start-client@7802

@tanstack/react-start-rsc

npm i https://pkg.pr.new/@tanstack/react-start-rsc@7802

@tanstack/react-start-server

npm i https://pkg.pr.new/@tanstack/react-start-server@7802

@tanstack/router-cli

npm i https://pkg.pr.new/@tanstack/router-cli@7802

@tanstack/router-core

npm i https://pkg.pr.new/@tanstack/router-core@7802

@tanstack/router-devtools

npm i https://pkg.pr.new/@tanstack/router-devtools@7802

@tanstack/router-devtools-core

npm i https://pkg.pr.new/@tanstack/router-devtools-core@7802

@tanstack/router-generator

npm i https://pkg.pr.new/@tanstack/router-generator@7802

@tanstack/router-plugin

npm i https://pkg.pr.new/@tanstack/router-plugin@7802

@tanstack/router-ssr-query-core

npm i https://pkg.pr.new/@tanstack/router-ssr-query-core@7802

@tanstack/router-utils

npm i https://pkg.pr.new/@tanstack/router-utils@7802

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/@tanstack/router-vite-plugin@7802

@tanstack/solid-router

npm i https://pkg.pr.new/@tanstack/solid-router@7802

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/@tanstack/solid-router-devtools@7802

@tanstack/solid-router-ssr-query

npm i https://pkg.pr.new/@tanstack/solid-router-ssr-query@7802

@tanstack/solid-start

npm i https://pkg.pr.new/@tanstack/solid-start@7802

@tanstack/solid-start-client

npm i https://pkg.pr.new/@tanstack/solid-start-client@7802

@tanstack/solid-start-server

npm i https://pkg.pr.new/@tanstack/solid-start-server@7802

@tanstack/start-client-core

npm i https://pkg.pr.new/@tanstack/start-client-core@7802

@tanstack/start-fn-stubs

npm i https://pkg.pr.new/@tanstack/start-fn-stubs@7802

@tanstack/start-plugin-core

npm i https://pkg.pr.new/@tanstack/start-plugin-core@7802

@tanstack/start-server-core

npm i https://pkg.pr.new/@tanstack/start-server-core@7802

@tanstack/start-static-server-functions

npm i https://pkg.pr.new/@tanstack/start-static-server-functions@7802

@tanstack/start-storage-context

npm i https://pkg.pr.new/@tanstack/start-storage-context@7802

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@7802

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@7802

@tanstack/vue-router

npm i https://pkg.pr.new/@tanstack/vue-router@7802

@tanstack/vue-router-devtools

npm i https://pkg.pr.new/@tanstack/vue-router-devtools@7802

@tanstack/vue-router-ssr-query

npm i https://pkg.pr.new/@tanstack/vue-router-ssr-query@7802

@tanstack/vue-start

npm i https://pkg.pr.new/@tanstack/vue-start@7802

@tanstack/vue-start-client

npm i https://pkg.pr.new/@tanstack/vue-start-client@7802

@tanstack/vue-start-server

npm i https://pkg.pr.new/@tanstack/vue-start-server@7802

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@7802

commit: 2eb2cc3

@LadyBluenotes
LadyBluenotes merged commit 41f7bf3 into TanStack:main Jul 12, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(examples): align WorkOS README redirect URI with callback route

2 participants