Skip to content

docs: improve local setup instructions in README#64

Open
im-vedant wants to merge 2 commits into
PSMRI:mainfrom
im-vedant:docs/add-dev-script-and-setup-instructions
Open

docs: improve local setup instructions in README#64
im-vedant wants to merge 2 commits into
PSMRI:mainfrom
im-vedant:docs/add-dev-script-and-setup-instructions

Conversation

@im-vedant

@im-vedant im-vedant commented May 3, 2026

Copy link
Copy Markdown

Summary

  • Updated README prerequisites to specify Node.js v16
  • Improved installation steps with correct npm install sequence (matching CI workflow)
  • Added step to copy local environment file to environment.ts
  • Updated local start command to npm start

Issue: PSMRI/AMRIT#111

Test plan

  • Follow README steps end-to-end and verify the app starts at http://localhost:4200/#/login
  • Verify cp src/environments/environment.local.ts src/environments/environment.ts works before npm start

- Added `npm run dev` script to package.json for running the app with the local environment (--env=local)
- Updated README prerequisites to specify Node.js v16
- Improved installation steps with correct npm install sequence and `npm run dev` as the local start command
@coderabbitai

coderabbitai Bot commented May 3, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@im-vedant has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 15 minutes 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: 8271d2f1-5a94-431a-9a31-6fc3c31277dc

📥 Commits

Reviewing files that changed from the base of the PR and between df5db19 and e38c4c9.

📒 Files selected for processing (1)
  • README.md
✨ 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
Review rate limit: 0/1 reviews remaining, refill in 15 minutes.

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

@im-vedant im-vedant changed the title docs: add dev script and improve local setup instructions docs: improve local setup instructions in README May 3, 2026
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