Docs: Local development setup – feedback, gaps & improvement ideas

[drtechie]

We are using this issue as a central place to collect feedback on the local development setup documentation for AMRIT.

If you’ve recently tried to set up AMRIT locally, please use this issue to suggest improvements to the docs.

---

🧭 Scope

This issue is about improving documentation for:

• Cloning the repositories and project structure overview
• Backend setup (Java/Spring, dependencies, env vars, DB)
• Frontend setup (Angular, npm, build/run)
• Docker / container-based setup
• Configuration for local environment
• Any missing prerequisites, troubleshooting tips, or gotchas

---

📝 How to give feedback

Please comment with:

1. What you were doing

   • e.g. "Setting up backend on Ubuntu", "Running UI locally on Windows"

2. Doc section or file

   • Link to the page/file

3. Problem / gap / confusion

   • What was unclear, missing, or misleading?

4. Your suggestion

   • A sentence/paragraph we could add
   • A screenshot, command example, or config snippet
   • Any tips that would have helped you

Example:

Section: README → Local Setup → Backend
Issue: DB config not clear for first-time users
Suggestion: Add sample application-local.properties and note about default credentials.

---

✅ How we’ll use this issue

• Collect all suggestions in one place
• Update the documentation iteratively
• Link common setup problems from the discussion thread
• Keep this issue open as a long-lived “meta” issue for documentation improvements

Thanks for helping us make AMRIT easier to set up for every new contributor 🙌

[ramnar]

What you were doing

Setting up Common UI

Doc section or file

https://github.com/PSMRI/Common-UI/blob/main/README.md

Problem / gap / confusion

I am beginner in Angular. Not clear how to start this reusable Module as Readme is not having steps

Your suggestion
Update Readme on the steps to start this module. Also mention what reusable components this module has. Mention in readme of all other UI Modules that Common-UI Is pre-requisite module. Better Option would be to automatically setup common-ui module when starting other modules using some script