Updating README.md with CLI local installation steps and Discord link#131
Updating README.md with CLI local installation steps and Discord link#131
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 31 minutes and 59 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughREADME.md updated with a new project introduction header containing navigation links, revised eCommerce terminology, and a "Get Started Locally" section documenting the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 `@README.md`:
- Line 43: Update the README sentence to clearly map ports: state that port 3000
is typically the Spree backend (including /admin) and the Next.js storefront dev
server runs on port 3001 by default (so the storefront URL is e.g.
http://localhost:3001), and note that the CLI or environment may assign
different ports so users should check the output or .env for actual ports; amend
the line mentioning "http://localhost:3000/admin" to reflect this distinction
and mention both ports (3000 for Spree admin, 3001 for Next.js storefront) and
that ports can differ if already in use.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| 1. Choose Full-stack (Backend + Next.js Storefront) or Backend only | ||
| 2. Optionally load sample data (products, categories, images) | ||
|
|
||
| Once complete, your store should be running at http://localhost:3000/admin. The port can be different if `3000` is already used on your system. You need to have Node.js 20+ and Docker running. |
There was a problem hiding this comment.
Clarify port information to avoid user confusion.
The statement "your store should be running at http://localhost:3000/admin" could be confusing in the context of a storefront README. Based on line 172, the Next.js storefront dev server runs on port 3001, while port 3000 typically hosts the Spree Commerce backend (including /admin).
Consider clarifying:
- Port 3000 = Spree backend admin panel
- Port 3001 (or different) = Next.js storefront
- Or specify that the CLI may use different ports
This would help users understand what to expect after running the setup command.
📝 Suggested clarification
-Once complete, your store should be running at http://localhost:3000/admin. The port can be different if `3000` is already used on your system. You need to have Node.js 20+ and Docker running.
+Once complete, the Spree backend admin should be accessible at http://localhost:3000/admin and the storefront at http://localhost:3001 (ports may vary if already in use). You need to have Node.js 20+ and Docker running.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Once complete, your store should be running at http://localhost:3000/admin. The port can be different if `3000` is already used on your system. You need to have Node.js 20+ and Docker running. | |
| Once complete, the Spree backend admin should be accessible at http://localhost:3000/admin and the storefront at http://localhost:3001 (ports may vary if already in use). You need to have Node.js 20+ and Docker running. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 43, Update the README sentence to clearly map ports: state
that port 3000 is typically the Spree backend (including /admin) and the Next.js
storefront dev server runs on port 3001 by default (so the storefront URL is
e.g. http://localhost:3001), and note that the CLI or environment may assign
different ports so users should check the output or .env for actual ports; amend
the line mentioning "http://localhost:3000/admin" to reflect this distinction
and mention both ports (3000 for Spree admin, 3001 for Next.js storefront) and
that ports can differ if already in use.
1 participant
Summary by CodeRabbit
npx create-spree-app@latest