Update README.md with correct local dev instructions

[keiwanmosaddegh]

Summary by CodeRabbit

• Documentation
  • Enhanced setup instructions with additional configuration steps for initial environment setup.
  • Improved documentation formatting and consistency for better readability and clarity.

[vercel]

@keiwanmosaddegh is attempting to deploy a commit to the Coderax's projects Team on Vercel.

A member of the Team first needs to authorize it.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[coderabbitai]

Walkthrough

README.md is updated to include initial setup steps before bringing services up, including installing dependencies, copying the environment configuration file, and setting the API_URL. List formatting is also normalized for consistency.

Changes

Cohort / File(s)	Summary
Documentation Updates README.md	Added setup instructions (pnpm install, copy .env, set API_URL) in the Start section preceding existing commands; normalized Redis terminal list formatting from double-dash to single-dash; introduced spacing after environment setup steps.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• Documentation-only changes with minimal scope
• No code logic or behavioral modifications
• Straightforward additions and formatting normalization

Poem

🐰 A Setup Tale

The README gets dressed in instructions so clear,
With pnpm install and .env drawing near,
Then dashes align in a uniform line,
The project's first steps now perfectly fine! ✨

Pre-merge checks and finishing touches

✅ 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 clearly and accurately summarizes the main change: updating README.md documentation with corrected local development setup instructions (pnpm install, .env configuration, and service startup steps).
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 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 da59622 and 649de59.

📒 Files selected for processing (1)

• README.md (2 hunks)

🔇 Additional comments (2)

README.md (2)

117-117: Good formatting normalization.

The prefix change from -- to - aligns the Redis terminal instruction with the Clickhouse terminal instruction above it, making the list formatting consistent.

---

101-104: All setup instructions are verified and accurate.

Verification confirms that .env.example exists, apps/start directory exists, and all referenced pnpm scripts (dock:up, codegen, migrate:deploy, dev, dock:redis, dock:ch) are defined in the package.json. The setup instructions in the README are correct and ready for new contributors.

Tip

📝 Customizable high-level summaries are now available!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

• Provide custom instructions to shape the summary (bullet lists, tables, contributor stats, etc.).
• Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example:

"Create a concise high-level summary as a bullet-point list. Then include a Markdown table showing lines added and removed by each contributing author."

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[keiwanmosaddegh]

@lindesvard a helpful update of the installation instructions in the README.md