Skip to content

Commit

Permalink
chore(docs): Updated module graph (#1840)
Browse files Browse the repository at this point in the history
* 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.
  • Loading branch information
niyajali authored Dec 30, 2024
1 parent df7ffea commit 6320f20
Show file tree
Hide file tree
Showing 14 changed files with 272 additions and 34 deletions.
2 changes: 0 additions & 2 deletions core/analytics/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# :core:analytics module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_analytics.svg)
2 changes: 0 additions & 2 deletions core/common/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# :core:common module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_common.svg)
27 changes: 24 additions & 3 deletions core/data/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
# :core:data module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_data.svg)
### Module Graph

```mermaid
%%{
init: {
'theme': 'neutral'
}
}%%
graph LR
subgraph :core
:core:data["data"]
:core:common["common"]
:core:datastore["datastore"]
:core:model["model"]
:core:network["network"]
:core:analytics["analytics"]
end
:core:data --> :core:common
:core:data --> :core:datastore
:core:data --> :core:model
:core:data --> :core:network
:core:data --> :core:analytics
```
21 changes: 18 additions & 3 deletions core/datastore/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
# :core:datastore module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_datastore.svg)
### Module Graph

```mermaid
%%{
init: {
'theme': 'neutral'
}
}%%
graph LR
subgraph :core
:core:datastore["datastore"]
:core:model["model"]
:core:common["common"]
end
:core:datastore --> :core:model
:core:datastore --> :core:common
```
19 changes: 16 additions & 3 deletions core/designsystem/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# :core:designsystem module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_designsystem.svg)
### Module Graph

```mermaid
%%{
init: {
'theme': 'neutral'
}
}%%
graph LR
subgraph :core
:core:designsystem["designsystem"]
:core:model["model"]
end
:core:designsystem --> :core:model
```
23 changes: 20 additions & 3 deletions core/domain/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
# :core:data module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_data.svg)
### Module Graph

```mermaid
%%{
init: {
'theme': 'neutral'
}
}%%
graph LR
subgraph :core
:core:domain["domain"]
:core:common["common"]
:core:data["data"]
:core:model["model"]
end
:core:domain --> :core:common
:core:domain --> :core:data
:core:domain --> :core:model
```
19 changes: 16 additions & 3 deletions core/model/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# :core:model module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_model.svg)
### Module Graph

```mermaid
%%{
init: {
'theme': 'neutral'
}
}%%
graph LR
subgraph :core
:core:model["model"]
:core:common["common"]
end
:core:model --> :core:common
```
23 changes: 20 additions & 3 deletions core/network/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
# :core:network module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_network.svg)
### Module Graph

```mermaid
%%{
init: {
'theme': 'neutral'
}
}%%
graph LR
subgraph :core
:core:network["network"]
:core:common["common"]
:core:model["model"]
:core:datastore["datastore"]
end
:core:network --> :core:common
:core:network --> :core:model
:core:network --> :core:datastore
```
25 changes: 22 additions & 3 deletions core/ui/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
# :core:ui module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_ui.svg)
### Module Graph

```mermaid
%%{
init: {
'theme': 'neutral'
}
}%%
graph LR
subgraph :core
:core:ui["ui"]
:core:analytics["analytics"]
:core:designsystem["designsystem"]
:core:model["model"]
:core:common["common"]
end
:core:ui --> :core:analytics
:core:ui --> :core:designsystem
:core:ui --> :core:model
:core:ui --> :core:common
```
5 changes: 2 additions & 3 deletions feature/accounts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@

### Android

https://github.com/user-attachments/assets/40c2da0b-776f-4378-9873-4701afe3fa96

https://github.com/user-attachments/assets/7ca2db8b-cdfc-4a72-bc0a-9113d597c17b
| ![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) |
|------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|

### Desktop

Expand Down
21 changes: 18 additions & 3 deletions mifospay-android/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
# :mifospay module
## Dependency graph
![Dependency graph](../docs/images/graphs/dep_graph_mifospay.svg)
### Module Graph

```mermaid
%%{
init: {
'theme': 'neutral'
}
}%%
graph LR
subgraph :core
:core:data["data"]
:core:ui["ui"]
end
:mifospay-android --> :mifospay-shared
:mifospay-android --> :core:data
:mifospay-android --> :core:ui
```
23 changes: 22 additions & 1 deletion mifospay-desktop/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,22 @@
To run in desktop mode, choose the `mifospay-desktop` profile and click run.
### Module Graph

```mermaid
%%{
init: {
'theme': 'neutral'
}
}%%
graph LR
subgraph :core
:core:common["common"]
:core:data["data"]
:core:model["model"]
:core:datastore["datastore"]
end
:mifospay-desktop --> :core:common
:mifospay-desktop --> :core:data
:mifospay-desktop --> :core:model
:mifospay-desktop --> :core:datastore
:mifospay-desktop --> :mifospay-shared
```
73 changes: 73 additions & 0 deletions mifospay-shared/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
### Module Graph

```mermaid
%%{
init: {
'theme': 'neutral'
}
}%%
graph LR
subgraph :core
:core:data["data"]
:core:network["network"]
:core:ui["ui"]
:core:designsystem["designsystem"]
:core:domain["domain"]
end
subgraph :feature
:feature:auth["auth"]
:feature:home["home"]
:feature:settings["settings"]
:feature:faq["faq"]
:feature:editpassword["editpassword"]
:feature:profile["profile"]
:feature:history["history"]
:feature:payments["payments"]
:feature:finance["finance"]
:feature:accounts["accounts"]
:feature:invoices["invoices"]
:feature:kyc["kyc"]
:feature:notification["notification"]
:feature:savedcards["savedcards"]
:feature:receipt["receipt"]
:feature:standing-instruction["standing-instruction"]
:feature:request-money["request-money"]
:feature:send-money["send-money"]
:feature:make-transfer["make-transfer"]
:feature:qr["qr"]
:feature:merchants["merchants"]
:feature:upi-setup["upi-setup"]
end
subgraph :libs
:libs:mifos-passcode["mifos-passcode"]
end
:mifospay-shared --> :core:data
:mifospay-shared --> :core:network
:mifospay-shared --> :core:ui
:mifospay-shared --> :core:designsystem
:mifospay-shared --> :core:domain
:mifospay-shared --> :feature:auth
:mifospay-shared --> :libs:mifos-passcode
:mifospay-shared --> :feature:home
:mifospay-shared --> :feature:settings
:mifospay-shared --> :feature:faq
:mifospay-shared --> :feature:editpassword
:mifospay-shared --> :feature:profile
:mifospay-shared --> :feature:history
:mifospay-shared --> :feature:payments
:mifospay-shared --> :feature:finance
:mifospay-shared --> :feature:accounts
:mifospay-shared --> :feature:invoices
:mifospay-shared --> :feature:kyc
:mifospay-shared --> :feature:notification
:mifospay-shared --> :feature:savedcards
:mifospay-shared --> :feature:receipt
:mifospay-shared --> :feature:standing-instruction
:mifospay-shared --> :feature:request-money
:mifospay-shared --> :feature:send-money
:mifospay-shared --> :feature:make-transfer
:mifospay-shared --> :feature:qr
:mifospay-shared --> :feature:merchants
:mifospay-shared --> :feature:upi-setup
```
23 changes: 21 additions & 2 deletions mifospay-web/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
To run in web mode, choose the `mifospay-web-js` or `mifospay-web-wasm` profile and click run.
### Module Graph

_When running as WasmJs it will take some time to compile the webpack, so be patient._
```mermaid
%%{
init: {
'theme': 'neutral'
}
}%%
graph LR
subgraph :core
:core:common["common"]
:core:data["data"]
:core:model["model"]
:core:datastore["datastore"]
end
:mifospay-web --> :mifospay-shared
:mifospay-web --> :core:common
:mifospay-web --> :core:data
:mifospay-web --> :core:model
:mifospay-web --> :core:datastore
```

0 comments on commit 6320f20

Please sign in to comment.