Skip to content

docs: clarify Common-UI role in codebase structure #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ShivaniSharma14 wants to merge 1 commit into
base: main
Choose a base branch
from
+1 −0
Open

docs: clarify Common-UI role in codebase structure #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions developer-guide/codebase-structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ AMRIT follows a **loosely coupled architecture**, where each module functions in
* **UI to API Communication**: Angular applications interact with backend services via REST APIs, using `HttpClient` for communication.
* **Mobile App to API Communication**: Android apps consume the same APIs used by the UI modules, enabling uniform behavior across platforms.
* **Shared Components**: Common-UI and Common-API are reusable components shared across multiple modules, ensuring consistency.
* **Common-UI note for first-time contributors**: Common-UI is a shared dependency used by many AMRIT UI products and is commonly added as a Git submodule. It should be treated as shared infrastructure rather than as a standalone product application. Before starting a UI repository locally, check whether it depends on Common-UI or other shared components.

***

Expand Down