Skip to content

Commit 6320f20

Browse files
niyajaliniyajali
authored
chore(docs): Updated module graph (#1840)
* chore: Update web dependencies Updated the following dependencies: - Upgraded `enhanced-resolve` from 5.17.0 to 5.18.0 - Upgraded `karma` from 6.4.3 to 6.4.4 - Upgraded `kotlin-web-helpers` to 2.0.0 - Upgraded `mocha` from 10.7.0 to 10.7.3 - Upgraded `webpack` from 5.93.0 to 5.94.0 - Upgraded `ws` from 8.5.0 to 8.18.0 Removed the following dependencies: - `@types/eslint` - `@types/eslint-scope` Also, updated the multi-platform build and publish workflow to use `niyajali/mifos-mobile-github-actions` instead of `openMF/mifos-mobile-github-actions`. * ci: Update GitHub Actions workflow This commit updates the GitHub Actions workflows to: - Remove the pull request trigger from the `build-and-deploy-site` workflow. The workflow will now only be triggered manually or on a schedule. - Add `build_ios` as an input to the `multi-platform-build-and-publish` workflow to control whether the iOS app should be built. - Remove unused inputs from the `multi-platform-build-and-publish` workflow, including `publish_desktop` and `publish_web`. * docs: Add module graphs for all modules This commit adds module graphs to the README files of all modules, providing a visual representation of the dependencies between them. The graphs are generated using Mermaid.js and show the relationships between modules, making it easier to understand the overall structure of the project.
1 parent df7ffea commit 6320f20

File tree

14 files changed

+272
-34
lines changed

14 files changed

+272
-34
lines changed

‎core/analytics/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
11
# :core:analytics module
2-
## Dependency graph
3-
![Dependency graph](../../docs/images/graphs/dep_graph_core_analytics.svg)

‎core/common/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
11
# :core:common module
2-
## Dependency graph
3-
![Dependency graph](../../docs/images/graphs/dep_graph_core_common.svg)

‎core/data/README.md

+24-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
1-
# :core:data module
2-
## Dependency graph
3-
![Dependency graph](../../docs/images/graphs/dep_graph_core_data.svg)
1+
### Module Graph
2+
3+
```mermaid
4+
%%{
5+
init: {
6+
'theme': 'neutral'
7+
}
8+
}%%
9+
10+
graph LR
11+
subgraph :core
12+
:core:data["data"]
13+
:core:common["common"]
14+
:core:datastore["datastore"]
15+
:core:model["model"]
16+
:core:network["network"]
17+
:core:analytics["analytics"]
18+
end
19+
:core:data --> :core:common
20+
:core:data --> :core:datastore
21+
:core:data --> :core:model
22+
:core:data --> :core:network
23+
:core:data --> :core:analytics
24+
```

‎core/datastore/README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1-
# :core:datastore module
2-
## Dependency graph
3-
![Dependency graph](../../docs/images/graphs/dep_graph_core_datastore.svg)
1+
### Module Graph
2+
3+
```mermaid
4+
%%{
5+
init: {
6+
'theme': 'neutral'
7+
}
8+
}%%
9+
10+
graph LR
11+
subgraph :core
12+
:core:datastore["datastore"]
13+
:core:model["model"]
14+
:core:common["common"]
15+
end
16+
:core:datastore --> :core:model
17+
:core:datastore --> :core:common
18+
```

‎core/designsystem/README.md

+16-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1-
# :core:designsystem module
2-
## Dependency graph
3-
![Dependency graph](../../docs/images/graphs/dep_graph_core_designsystem.svg)
1+
### Module Graph
2+
3+
```mermaid
4+
%%{
5+
init: {
6+
'theme': 'neutral'
7+
}
8+
}%%
9+
10+
graph LR
11+
subgraph :core
12+
:core:designsystem["designsystem"]
13+
:core:model["model"]
14+
end
15+
:core:designsystem --> :core:model
16+
```

‎core/domain/README.md

+20-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1-
# :core:data module
2-
## Dependency graph
3-
![Dependency graph](../../docs/images/graphs/dep_graph_core_data.svg)
1+
### Module Graph
2+
3+
```mermaid
4+
%%{
5+
init: {
6+
'theme': 'neutral'
7+
}
8+
}%%
9+
10+
graph LR
11+
subgraph :core
12+
:core:domain["domain"]
13+
:core:common["common"]
14+
:core:data["data"]
15+
:core:model["model"]
16+
end
17+
:core:domain --> :core:common
18+
:core:domain --> :core:data
19+
:core:domain --> :core:model
20+
```

‎core/model/README.md

+16-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1-
# :core:model module
2-
## Dependency graph
3-
![Dependency graph](../../docs/images/graphs/dep_graph_core_model.svg)
1+
### Module Graph
2+
3+
```mermaid
4+
%%{
5+
init: {
6+
'theme': 'neutral'
7+
}
8+
}%%
9+
10+
graph LR
11+
subgraph :core
12+
:core:model["model"]
13+
:core:common["common"]
14+
end
15+
:core:model --> :core:common
16+
```

‎core/network/README.md

+20-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1-
# :core:network module
2-
## Dependency graph
3-
![Dependency graph](../../docs/images/graphs/dep_graph_core_network.svg)
1+
### Module Graph
2+
3+
```mermaid
4+
%%{
5+
init: {
6+
'theme': 'neutral'
7+
}
8+
}%%
9+
10+
graph LR
11+
subgraph :core
12+
:core:network["network"]
13+
:core:common["common"]
14+
:core:model["model"]
15+
:core:datastore["datastore"]
16+
end
17+
:core:network --> :core:common
18+
:core:network --> :core:model
19+
:core:network --> :core:datastore
20+
```

‎core/ui/README.md

+22-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1-
# :core:ui module
2-
## Dependency graph
3-
![Dependency graph](../../docs/images/graphs/dep_graph_core_ui.svg)
1+
### Module Graph
2+
3+
```mermaid
4+
%%{
5+
init: {
6+
'theme': 'neutral'
7+
}
8+
}%%
9+
10+
graph LR
11+
subgraph :core
12+
:core:ui["ui"]
13+
:core:analytics["analytics"]
14+
:core:designsystem["designsystem"]
15+
:core:model["model"]
16+
:core:common["common"]
17+
end
18+
:core:ui --> :core:analytics
19+
:core:ui --> :core:designsystem
20+
:core:ui --> :core:model
21+
:core:ui --> :core:common
22+
```

‎feature/accounts/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44

55
### Android
66

7-
https://github.com/user-attachments/assets/40c2da0b-776f-4378-9873-4701afe3fa96
8-
9-
https://github.com/user-attachments/assets/7ca2db8b-cdfc-4a72-bc0a-9113d597c17b
7+
| ![Screenshot (101)](https://github.com/user-attachments/assets/40c2da0b-776f-4378-9873-4701afe3fa96) | ![Screenshot (102)](https://github.com/user-attachments/assets/7ca2db8b-cdfc-4a72-bc0a-9113d597c17b) |
8+
|------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|
109

1110
### Desktop
1211

‎mifospay-android/README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1-
# :mifospay module
2-
## Dependency graph
3-
![Dependency graph](../docs/images/graphs/dep_graph_mifospay.svg)
1+
### Module Graph
2+
3+
```mermaid
4+
%%{
5+
init: {
6+
'theme': 'neutral'
7+
}
8+
}%%
9+
10+
graph LR
11+
subgraph :core
12+
:core:data["data"]
13+
:core:ui["ui"]
14+
end
15+
:mifospay-android --> :mifospay-shared
16+
:mifospay-android --> :core:data
17+
:mifospay-android --> :core:ui
18+
```

‎mifospay-desktop/README.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,22 @@
1-
To run in desktop mode, choose the `mifospay-desktop` profile and click run.
1+
### Module Graph
2+
3+
```mermaid
4+
%%{
5+
init: {
6+
'theme': 'neutral'
7+
}
8+
}%%
9+
10+
graph LR
11+
subgraph :core
12+
:core:common["common"]
13+
:core:data["data"]
14+
:core:model["model"]
15+
:core:datastore["datastore"]
16+
end
17+
:mifospay-desktop --> :core:common
18+
:mifospay-desktop --> :core:data
19+
:mifospay-desktop --> :core:model
20+
:mifospay-desktop --> :core:datastore
21+
:mifospay-desktop --> :mifospay-shared
22+
```

‎mifospay-shared/README.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
### Module Graph
2+
3+
```mermaid
4+
%%{
5+
init: {
6+
'theme': 'neutral'
7+
}
8+
}%%
9+
10+
graph LR
11+
subgraph :core
12+
:core:data["data"]
13+
:core:network["network"]
14+
:core:ui["ui"]
15+
:core:designsystem["designsystem"]
16+
:core:domain["domain"]
17+
end
18+
subgraph :feature
19+
:feature:auth["auth"]
20+
:feature:home["home"]
21+
:feature:settings["settings"]
22+
:feature:faq["faq"]
23+
:feature:editpassword["editpassword"]
24+
:feature:profile["profile"]
25+
:feature:history["history"]
26+
:feature:payments["payments"]
27+
:feature:finance["finance"]
28+
:feature:accounts["accounts"]
29+
:feature:invoices["invoices"]
30+
:feature:kyc["kyc"]
31+
:feature:notification["notification"]
32+
:feature:savedcards["savedcards"]
33+
:feature:receipt["receipt"]
34+
:feature:standing-instruction["standing-instruction"]
35+
:feature:request-money["request-money"]
36+
:feature:send-money["send-money"]
37+
:feature:make-transfer["make-transfer"]
38+
:feature:qr["qr"]
39+
:feature:merchants["merchants"]
40+
:feature:upi-setup["upi-setup"]
41+
end
42+
subgraph :libs
43+
:libs:mifos-passcode["mifos-passcode"]
44+
end
45+
:mifospay-shared --> :core:data
46+
:mifospay-shared --> :core:network
47+
:mifospay-shared --> :core:ui
48+
:mifospay-shared --> :core:designsystem
49+
:mifospay-shared --> :core:domain
50+
:mifospay-shared --> :feature:auth
51+
:mifospay-shared --> :libs:mifos-passcode
52+
:mifospay-shared --> :feature:home
53+
:mifospay-shared --> :feature:settings
54+
:mifospay-shared --> :feature:faq
55+
:mifospay-shared --> :feature:editpassword
56+
:mifospay-shared --> :feature:profile
57+
:mifospay-shared --> :feature:history
58+
:mifospay-shared --> :feature:payments
59+
:mifospay-shared --> :feature:finance
60+
:mifospay-shared --> :feature:accounts
61+
:mifospay-shared --> :feature:invoices
62+
:mifospay-shared --> :feature:kyc
63+
:mifospay-shared --> :feature:notification
64+
:mifospay-shared --> :feature:savedcards
65+
:mifospay-shared --> :feature:receipt
66+
:mifospay-shared --> :feature:standing-instruction
67+
:mifospay-shared --> :feature:request-money
68+
:mifospay-shared --> :feature:send-money
69+
:mifospay-shared --> :feature:make-transfer
70+
:mifospay-shared --> :feature:qr
71+
:mifospay-shared --> :feature:merchants
72+
:mifospay-shared --> :feature:upi-setup
73+
```

‎mifospay-web/README.md

+21-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1-
To run in web mode, choose the `mifospay-web-js` or `mifospay-web-wasm` profile and click run.
1+
### Module Graph
22

3-
_When running as WasmJs it will take some time to compile the webpack, so be patient._
3+
```mermaid
4+
%%{
5+
init: {
6+
'theme': 'neutral'
7+
}
8+
}%%
9+
10+
graph LR
11+
subgraph :core
12+
:core:common["common"]
13+
:core:data["data"]
14+
:core:model["model"]
15+
:core:datastore["datastore"]
16+
end
17+
:mifospay-web --> :mifospay-shared
18+
:mifospay-web --> :core:common
19+
:mifospay-web --> :core:data
20+
:mifospay-web --> :core:model
21+
:mifospay-web --> :core:datastore
22+
```

0 commit comments

Comments
 (0)