Skip to content

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

Open
pavan-sh wants to merge 5 commits 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 5 commits 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

  • Chores
    • Added new auth:login npm script command for authentication login operations.

@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 2bcd6ce

@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: 8b23a8e1-9ca9-419a-9fdf-60a1aad65a72

📥 Commits

Reviewing files that changed from the base of the PR and between a378dad and 2bcd6ce.

📒 Files selected for processing (1)
  • package.json
✅ Files skipped from review due to trivial changes (1)
  • package.json

📝 Walkthrough

Walkthrough

A new npm script entry auth:login is added to package.json, enabling direct execution of the scripts/auth-login.ts TypeScript file through the tsx runtime without any other modifications.

Changes

Cohort / File(s) Summary
Package Configuration
package.json
Added new npm script entry "auth:login": "tsx scripts/auth-login.ts" to enable TypeScript authentication script execution.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A tiny script hops into place,
Auth login now runs with grace,
One line added, swift and clean,
The easiest change we've seen!

🚥 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 mentions adding an auth login script and fixing README setup, which aligns with the PR objectives of adding the auth:login script to package.json and updating README instructions.
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.

✏️ 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.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@package.json`:
- Around line 10-12: The package.json contains a duplicate "with-env" script
key; remove the unintended entry that runs "dotenv -e ../../.env" so only the
intended "with-env": "dotenv -e .env.local" remains. Locate the duplicate
"with-env" script in package.json and delete the line that references
"../../.env" (leave the "dotenv -e .env.local" entry), then run a quick
lint/format check to ensure no duplicate keys remain.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7b31e2a3-1933-430c-a128-2946d91d66ed

📥 Commits

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

📒 Files selected for processing (2)
  • README.md
  • package.json
✅ Files skipped from review due to trivial changes (1)
  • README.md

Comment thread package.json
Removed setup instructions for running the app locally.
Updated the 'with-env' script to use '.env.local' instead of '../../.env'.
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