Skip to content

docs: add ecosystem architecture and contributor onboarding guide#154

Open
PragyaTripathi990 wants to merge 1 commit into
PSMRI:mainfrom
PragyaTripathi990:docs/ecosystem-architecture-and-onboarding-guide
Open

docs: add ecosystem architecture and contributor onboarding guide#154
PragyaTripathi990 wants to merge 1 commit into
PSMRI:mainfrom
PragyaTripathi990:docs/ecosystem-architecture-and-onboarding-guide

Conversation

@PragyaTripathi990
Copy link
Copy Markdown

Problem

New contributors to AMRIT face a steep onboarding curve because the README jumps straight into repo links without explaining the ecosystem, architecture, or how to start services in the correct order. This causes repeated questions in issues and slow ramp-up for GSoC/DMP applicants.

Related issues: #111

What this PR adds

A new "Understanding the AMRIT Ecosystem" section between "Getting Started" and "Repositories", covering:

  • Service lines table — HWC, MMU, Helpline 104/1097, ECD, FLW, Scheduler with brief descriptions
  • Architecture overviewAngular UI → Spring Boot API → MySQL with shared dependencies (Admin-API, Identity-API, Common-API)
  • Frontend ↔ Backend port mapping table — lets contributors know which UI talks to which API and on which ports
  • Beneficiary data flow — 8-step sequence showing how a patient record moves through registration → nurse → doctor → pharmacy
  • New Contributor Journey — 5-step guide with a prerequisites table (Java 17, Maven 3.8+, Node.js 18+, Angular CLI, Docker, MySQL 8.0+, Redis 6+)
  • Service startup orderMySQL → Redis → Admin-API → Identity-API → Common-API → target API → target UI
  • Common local setup issues — troubleshooting table covering the top errors new contributors hit (referencing existing issues [HelpLine104 API]: Local Setup of the api is not working #122 and [HelpLine 104 UI]: Helpline104 UI Local Setup is not Working #123)

Why this matters

  • Reduces time-to-first-PR for new contributors
  • Prevents redundant "how do I set up locally?" issues
  • Makes the AMRIT monorepo README useful as a navigation hub, not just a link dump
  • Follows the pattern established by large OSS projects (Django, Kubernetes) where the root README serves as an onboarding entry point

Test plan

  • README renders correctly on GitHub (check table alignment, code blocks, headers)
  • All port numbers in the mapping table match values in the individual repo READMEs
  • Service startup order is consistent with docker-compose.yml and existing setup guides

🤖 Generated with Claude Code

Adds a comprehensive new section to the README covering:
- AMRIT service lines table (HWC, MMU, 104/1097, ECD, FLW, Scheduler)
- Architecture diagram with frontend↔backend port mapping
- Beneficiary data flow sequence
- New contributor journey with prerequisites and startup order
- Common local setup issues troubleshooting table

Closes PSMRI#111

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 10, 2026

Warning

Rate limit exceeded

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

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ 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: 7487d341-19b9-457c-a831-b06409a5b556

📥 Commits

Reviewing files that changed from the base of the PR and between 4f3a2f6 and ed36850.

📒 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

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

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