docs: Add DevContainer and Docker setup instructions to README (Closes #2)

[echelonnought]

Summary

Implements Issue #2 -- Update README instructions to include devcontainer instructions.

What Changed

The README's setup section has been restructured from a single installation path into three clearly documented options:

Option A: DevContainer Setup (Recommended)

• Step-by-step instructions for VS Code + Remote Development extension
• Explains the 'Reopen in Container' workflow
• Notes that the container auto-installs ESLint and GitLens extensions
• References the devcontainer.json and docker-compose.yml config files

Option B: Docker Setup (Without VS Code)

• Direct docker compose commands for users who don't use VS Code
• Includes both 'up' and 'down' commands

Option C: Manual Installation

• The original pnpm-based setup instructions (preserved as-is)
• Moved dev server start command into this section for completeness

Other Changes

• Added Docker Desktop to the Prerequisites list
• Reorganized the Development section to avoid duplicating the 'pnpm run dev' command

Files Changed

• README.md (+63 lines, -10 lines)

[coderabbitai]

Warning

Rate limit exceeded

@echelonnought has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 35 minutes and 6 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: abe53faa-4715-4e5b-898a-72df01a92a16

📥 Commits

Reviewing files that changed from the base of the PR and between c4ded60 and 5de6e71.

📒 Files selected for processing (1)

• README.md

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/2-readme-devcontainer-instructions

---

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

_{Review rate limit: 0/1 reviews remaining, refill in 35 minutes and 6 seconds.}

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

[echelonnought]

Detailed Implementation Notes

Why three options?

The original issue noted that devcontainers are the way most people will want to run the app. However, not everyone uses VS Code, and some contributors may prefer a bare-metal setup. The three-tier structure (DevContainer > Docker > Manual) lets contributors choose based on their tooling.

What the DevContainer does under the hood

The .devcontainer/devcontainer.json references .docker/docker-compose.yml which:

1. Builds from .docker/Dockerfile (Node 20 Alpine + pnpm)
2. Mounts the project directory as a bind volume at /app
3. Exposes port 5173 for the Vite dev server
4. Runs pnpm install as the postCreateCommand
5. Auto-installs ESLint and GitLens extensions in VS Code

What was preserved

The original manual installation instructions are fully preserved as Option C. No existing documentation was removed -- only reorganized and expanded.

Files Changed

• README.md: +63 lines, -10 lines (net +53 lines of documentation)

[SAUMILDHANKAR]

could be just me but this was unsuccessful at

RUN corepack enable     && corepack prepare pnpm@* --activate     && pnpm install --frozen-lockfile:

Further error log mentions

Error [ERR_UNKNOWN_BUILTIN_MODULE]: No such built-in module: node:sqlite

so will look into that

Thanks for working on this.