Skip to content

docs: add auth login script and fix local README setup#809

Open
pavan-sh wants to merge 1 commit intoTanStack:mainfrom
pavan-sh:docs/fix-auth-login-readme
Open

docs: add auth login script and fix local README setup#809
pavan-sh wants to merge 1 commit intoTanStack:mainfrom
pavan-sh:docs/fix-auth-login-readme

Conversation

@pavan-sh
Copy link
Copy Markdown
Contributor

@pavan-sh pavan-sh commented Apr 5, 2026

Summary

Fix the local auth/setup instructions for contributors.

  • add an auth:login script to package.json
  • keep the README auth commands aligned with the package script
  • fix the local dev URL in the README from https://localhost:3000 to http://localhost:3000

Why

The README pointed contributors to pnpm auth:login, but that script did not exist in package.json, which made the documented command fail. The localhost protocol in the README was also inconsistent with the dev server setup.

Summary by CodeRabbit

  • Documentation

    • Corrected the development server URL in setup instructions from HTTPS to HTTP for localhost.
  • Chores

    • Added new authentication login command for development.

@netlify
Copy link
Copy Markdown

netlify bot commented Apr 5, 2026

👷 Deploy request for tanstack pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit b311e2d

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 5, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 194dbee8-5077-41b0-b9ac-421009ec565e

📥 Commits

Reviewing files that changed from the base of the PR and between 43fa62c and b311e2d.

📒 Files selected for processing (2)
  • README.md
  • package.json

📝 Walkthrough

Walkthrough

Two minimal changes: corrected the default dev server URL scheme from HTTPS to HTTP in README documentation, and added a new auth:login npm script that executes tsx scripts/auth-login.ts.

Changes

Cohort / File(s) Summary
Documentation
README.md
Corrected dev server URL scheme from https://localhost:3000 to http://localhost:3000 in local preview setup section.
Package Configuration
package.json
Added new npm/pnpm script auth:login that runs tsx scripts/auth-login.ts.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A tiny hop and skip, the doc's now right,
HTTPS became HTTP—what a sight!
And new auth scripts hop into place,
Our scripts file dancing with grace!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main changes: adding an auth login script and fixing the local README setup URL issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

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.

1 participant