Final Work Product Submission for Google Summer of Code'20 at The Mifos Initiative - Karan Takalkar(@karantakalkar)

GSoC_2020.md

GSoC'20 Work Product Submission Mifos X Web App | Karan Takalkar

Project Overview

Mifos X Web App is the revamped version of the Mifos X Community App, an effective financial inclusion solution and the default web application built on top of the Mifos X platform for the Mifos User Community. It provides the front-end for a core banking system. Due to the limitations of Angular 1.x, the community app is being rewritten as the web app leveraging Angular 9 and Material Design. This project strives to finish the work which began in 2018.

Work Overview

Commits | Live Demo

Table of Contents

1. Dependencies Update
2. Home Module
3. Groups Module
4. Clients Module
5. Shares Module
6. Savings Module
7. FD Module
8. Organisation Module
9. Templates Module
10. Other Work
11. Credits

Project Progress Trackers

• Github Milestones
  • Phase 1
  • Phase 2
  • Phase 3
• Spreadsheet Tracker (Link)

section-0.md

Dependencies Update

New Dependencies:

Angular 9

To keep the web app upto date with the latest released stable version of Angular and to resolve repetitive build failures [1], it was decided to upgrade it to Angular 9.

• Updated all dependencies to their latest versions.
• Travis configuration was updated to use Angular 9.
• Configured Ivy (Angular's next-gen compilation engine).

Upgrade Documentation:

• v7 to v8 migration docs
• v8 to v9 migration docs

Chart.js

• It was decided to use Chart.js as a third party library for the implementation of charts in the web app.
• Official Website
• Mailing List Thread

CKEditor5

• It was decided to use CKEditor5 as a third party library for the implementation of text editor in the web app.
• Official Website
• Mailing List Thread

Related Issues:
[1] openMF/web-app#1216
[2] openMF/web-app#1181
[3] openMF/web-app#772

Related Pull Requests:
[1] openMF/web-app#1215
[2] openMF/web-app#1182
[3] openMF/web-app#773

section-1.md

Home Module

Features Completed:

• Dashboard User Interface.

Dashboard

• URL to String Pipe

A pipe that coverts URL strings to human readable strings.

Related Issues:
[1] openMF/web-app#808
[2] openMF/web-app#836

Related Pull Requests:
[1] openMF/web-app#811
[2] openMF/web-app#837

section-2.md

Groups Module

Features Completed:

• Primary Components.

Create	View	Edit

Related Issues:
[1] openMF/web-app#217
[2] openMF/web-app#778
[3] openMF/web-app#776
[4] openMF/web-app#777
[5] openMF/web-app#791
[6] openMF/web-app#212
[7] openMF/web-app#1036

Related Pull Requests:
[1] openMF/web-app#784
[2] openMF/web-app#789
[3] openMF/web-app#790
[4] openMF/web-app#793
[5] openMF/web-app#601
[6] openMF/web-app#1037

• Basic Actions

Activate	Delete	Close

Related Issues:
[1] openMF/web-app#1032
[2] openMF/web-app#1034
[3] openMF/web-app#1030

Related Pull Requests:
[1] openMF/web-app#1033
[2] openMF/web-app#1035
[3] openMF/web-app#1031

• Meetings and Attendance

Attach Meeting	Edit Meeting	Edit Meeting Schedule	Attendance

Related Issues:
[1] openMF/web-app#1044
[2] openMF/web-app#1051
[3] openMF/web-app#1053
[4] openMF/web-app#1046

Related Pull Requests:
[1] openMF/web-app#1033
[2] openMF/web-app#1052
[3] openMF/web-app#1054
[4] openMF/web-app#1035

• Manage Members and Transfer Clients

Manage Members	Transfer Clients

Related Issues:
[1] openMF/web-app#1044
[2] openMF/web-app#1051

Related Pull Requests:
[1] openMF/web-app#1033
[2] openMF/web-app#1052

• Staff and Role Assign/Unassign

Staff	Role

Related Issues:
[1] openMF/web-app#1028
[2] openMF/web-app#1026

Related Pull Requests:
[1] openMF/web-app#1029
[2] openMF/web-app#1027

Module Progress Tracker:

• https://docs.google.com/spreadsheets/d/1ZumIGyfbQR0bEEGXM9RnQy4HZMUTEIFTnULRtglOB4s/edit?usp=sharing

Pending Work:

• Entity Data Table Checks implementation (issue).

section-3.md

Clients Module

Features Completed:

• Primary Components.

Create	Edit

Related Issues:
[1] openMF/web-app#215
[2] openMF/web-app#1146

Related Pull Requests:
[1] openMF/web-app#1153
[2] openMF/web-app#1147

Known Issues:
Create client address step options unavailable on staging.mifos.io and dev.mifos.io
[1] Web App Ticket

• Basic Actions

Activate	Delete	Close

Reject	Withdraw	Update Savings

Reactivate	Undo Rejection	Add Charge

Related Issues:
[1] openMF/web-app#1074
[2] openMF/web-app#1072
[3] openMF/web-app#1070
[4] openMF/web-app#1068
[5] openMF/web-app#1076
[6] openMF/web-app#1078
[7] openMF/web-app#1100
[8] openMF/web-app#1102
[9] openMF/web-app#1104

Related Pull Requests:
[1] openMF/web-app#1075
[2] openMF/web-app#1073
[3] openMF/web-app#1071
[4] openMF/web-app#1069
[5] openMF/web-app#1077
[6] openMF/web-app#1079
[7] openMF/web-app#1101
[8] openMF/web-app#1103
[9] openMF/web-app#1105

• Transfer Actions

Transfer	Undo Transfer	Reject Transfer	Accept Transfer

Related Issues:
[1] openMF/web-app#1044
[2] openMF/web-app#1051
[3] openMF/web-app#1053
[4] openMF/web-app#1046

Related Pull Requests:
[1] openMF/web-app#1033
[2] openMF/web-app#1052
[3] openMF/web-app#1054
[4] openMF/web-app#1035

• Signature and Image Actions

Upload Signature	View Signature	Delete Signature

Upload Image	Capture Image	Delete Image

Related Issues:
[1] openMF/web-app#1119
[2] openMF/web-app#1121
[3] openMF/web-app#1129

Related Pull Requests:
[1] openMF/web-app#1120
[2] openMF/web-app#1122
[3] openMF/web-app#1130

Known Issues:
Backend errors while uploading client image or signature.
[1] ASF JIRA Ticket

• Staff Actions and Screen Reports

Staff	Screen Reports

Related Issues:
[1] openMF/web-app#1066
[2] openMF/web-app#1140

Related Pull Requests:
[1] openMF/web-app#1067
[2] openMF/web-app#1141

Module Progress Tracker:

• https://docs.google.com/spreadsheets/d/1ccV9ZY8mYu-7ExrYDAGLOQyCy83YTGSufjCSeU7sjPM/edit?usp=sharing

Pending Work:

• Entity Data Table Checks implementation (issue).
• Client Charges design and functionality needs refactoring (issue).
• Create Self Service User screen.(issue)
• At certain places wrong/missing permissions were there in community app need to harden permissions in this module.

section-4.md

Shares Module

Features Completed:

• Primary Components.

Create	View	Edit

Related Issues:
[1] openMF/web-app#224
[2] openMF/web-app#223
[3] openMF/web-app#880

Related Pull Requests:
[1] openMF/web-app#868
[2] openMF/web-app#877
[3] openMF/web-app#881

• Basic actions

Activate	Delete	Close

Approve	Undo Approval	Reject

Related Issues:
[1] openMF/web-app#889
[2] openMF/web-app#891
[3] openMF/web-app#893
[4] openMF/web-app#895
[5] openMF/web-app#897
[6] openMF/web-app#899

Related Pull Requests:
[1] openMF/web-app#890
[2] openMF/web-app#892
[3] openMF/web-app#894
[4] openMF/web-app#896
[5] openMF/web-app#898
[6] openMF/web-app#900

• Shares based actions

Apply Shares	Redeem Shares	Approve Shares	Reject Shares

Related Issues:
[1] openMF/web-app#901
[2] openMF/web-app#903
[3] openMF/web-app#907
[4] openMF/web-app#909

Related Pull Requests:
[1] openMF/web-app#902
[2] openMF/web-app#904
[3] openMF/web-app#908
[4] openMF/web-app#910

Module Progress Tracker:

• https://docs.google.com/spreadsheets/d/1wiH08XNwC9T6HkHN5vM_TYe7ShkKUrtphDDYepxAtRo/edit?usp=sharing

section-5.md

Savings Module

Features Completed:

• Primary Components.

Create	View	Edit

Related Issues:
[1] openMF/web-app#225
[2] openMF/web-app#1004
[3] openMF/web-app#226
[4] openMF/web-app#1010

Related Pull Requests:
[1] openMF/web-app#959
[2] openMF/web-app#960
[3] openMF/web-app#1005
[4] openMF/web-app#1001
[5] openMF/web-app#1011

• Basic actions

Activate	Delete	Close

Approve	Undo Approval	Reject

Withdraw	Post Interest	Calculate Interest

Related Issues:
[1] openMF/web-app#905
[2] openMF/web-app#911
[3] openMF/web-app#913
[4] openMF/web-app#915
[5] openMF/web-app#942
[6] openMF/web-app#918
[7] openMF/web-app#920
[8] openMF/web-app#928
[9] openMF/web-app#930

Related Pull Requests:
[1] openMF/web-app#906
[2] openMF/web-app#912
[3] openMF/web-app#914
[4] openMF/web-app#916
[5] openMF/web-app#943
[6] openMF/web-app#919
[7] openMF/web-app#921
[8] openMF/web-app#929
[9] openMF/web-app#931

• Staff and Tax actions

Assign Staff	Unassign Staff

Enable	Disable

Related Issues:
[1] openMF/web-app#924
[2] openMF/web-app#926
[3] openMF/web-app#944

Related Pull Requests:
[1] openMF/web-app#925
[2] openMF/web-app#927
[3] openMF/web-app#931

• Apply Annual Fees and Post Interest as on

Apply Annual Fees	Post Interest as on

Related Issues:
[1] openMF/web-app#957
[2] openMF/web-app#922

Related Pull Requests:
[1] openMF/web-app#958
[2] openMF/web-app#923

• Transactions actions

View Trasaction	Edit Transaction

View Reciept	Export

Related Issues:
[1] openMF/web-app#932
[2] openMF/web-app#953
[3] openMF/web-app#948
[4] openMF/web-app#946

Related Pull Requests:
[1] openMF/web-app#933
[2] openMF/web-app#954
[3] openMF/web-app#949
[4] openMF/web-app#950

• Charges actions

View Charge

Delete	Edit

Pay	Waive	Inactivate

Related Issues:
[1] openMF/web-app#938
[2] openMF/web-app#951

Related Pull Requests:
[1] openMF/web-app#939
[2] openMF/web-app#952

Module Progress Tracker:

• https://docs.google.com/spreadsheets/d/12pu2TTE_3o9aptwnQj79kvyY8-EEzpvAl-1rE30cvLg/edit?usp=sharing

Pending Work:

• Entity Data Table Checks implementation (issue).

section-6.md

Fixed Deposits Module

Features Completed:

• Primary Components.

Create	View	Edit

Related Issues:
[1] openMF/web-app#225
[2] openMF/web-app#1004
[3] openMF/web-app#226
[4] openMF/web-app#1010

Related Pull Requests:
[1] openMF/web-app#959
[2] openMF/web-app#960
[3] openMF/web-app#1005
[4] openMF/web-app#1001
[5] openMF/web-app#1011

• Basic actions

Activate	Delete	Close on Maturity

Approve	Undo Approval	Premature Close

Withdraw by Client	Reject	Add Charge

Related Issues:
[1] openMF/web-app#962
[2] openMF/web-app#964
[3] openMF/web-app#966
[4] openMF/web-app#976
[5] openMF/web-app#996
[6] openMF/web-app#994
[7] openMF/web-app#972
[8] openMF/web-app#974
[9] openMF/web-app#992

Related Pull Requests:
[1] openMF/web-app#963
[2] openMF/web-app#965
[3] openMF/web-app#967
[4] openMF/web-app#977
[5] openMF/web-app#997
[6] openMF/web-app#995
[7] openMF/web-app#973
[8] openMF/web-app#975
[9] openMF/web-app#993

• Calculate and Post Interest

Calculate Interest	Post Interest

Related Issues:
[1] openMF/web-app#968

Related Pull Requests:
[1] openMF/web-app#969

• Enable and Disable withhold tax

Enable	Disable

Related Issues:
[1] openMF/web-app#970

Related Pull Requests:
[1] openMF/web-app#971

• Transactions

View Trasaction

Related Issues:
[1] openMF/web-app#988

Related Pull Requests:
[1] openMF/web-app#989

• Charges

Delete	Edit

Pay	Waive	Inactivate

Related Issues:
[1] openMF/web-app#990

Related Pull Requests:
[1] openMF/web-app#991

Module Progress Tracker:

• https://docs.google.com/spreadsheets/d/1kKvzVdUiijqCiUg2a2GPzI5yD20H-tx7URX9ozuEBqs/edit?usp=sharing

section-7.md

Organisation Module

Features Completed:

• SMS Campaigns

Create	View	Edit

Close	Reactivate	Activate	Delete

Related Issues:
[1] openMF/web-app#167
[2] openMF/web-app#764
[3] openMF/web-app#563
[4] openMF/web-app#1163

Related Pull Requests:
[1] openMF/web-app#835
[2] openMF/web-app#851
[3] openMF/web-app#1164

• Teller Cashier Management

View Cashiers	View Cashier Transactions	Create Cashier

Related Issues:
[1] openMF/web-app#757
[2] openMF/web-app#760
[3] openMF/web-app#161

Related Pull Requests:
[1] openMF/web-app#888
[2] openMF/web-app#1061
[3] openMF/web-app#1064

• Bulk Imports

View Bulk Imports

Bulk-Imports have been implemented in a way that a single component can be re-used for all 18 Bulk-Imports pages.

Related Issues:
[1] openMF/web-app#633

Related Pull Requests:
[1] openMF/web-app#637

• Provisioning Criterias

Create Provisioning Criteria	Edit Provisioning Criteria

Related Issues:
[1] openMF/web-app#570
[2] openMF/web-app#644

Related Pull Requests:
[1] openMF/web-app#1167
[2] openMF/web-app#1168

• View Office

View Office

Related Issues:
[1] openMF/web-app#635

Related Pull Requests:
[1] openMF/web-app#828

• Standing Instructions History

Input Form	Output Table

Related Issues:
[1] openMF/web-app#1176

Related Pull Requests:
[1] openMF/web-app#1177

• Fund Mapping

Fund Mapping

Related Issues:
[1] openMF/web-app#1179

Related Pull Requests:
[1] openMF/web-app#1180

• Manage Funds and Manage Currencies

Manage Funds	Manage Currencies

Related Issues:
[1] openMF/web-app#155
[2] openMF/web-app#152

Related Pull Requests:
[1] openMF/web-app#886
[2] openMF/web-app#887

• Edit Adhoc Query and Create Holiday

Edit Adhoc Query	Create Holiday

Related Issues:
[1] openMF/web-app#752
[2] openMF/web-app#154

Related Pull Requests:
[1] openMF/web-app#1065
[2] openMF/web-app#1195

Pending Work:

• Create Holiday Checkbox Tree implementation (issue).
• Hardening of Bulk imports permissions (issue).

section-8.md

Templates Module

Features Completed:

• Create and Edit Template.

Create Template	Edit Template

Related Issues:
[1] openMF/web-app#702
[2] openMF/web-app#1184

Related Pull Requests:
[1] openMF/web-app#1183
[2] openMF/web-app#1185

section-9.md

Other Work

Features:

• Notifications Tray.

• Notifications Page

Notifications Page

Related Issues:
[1] openMF/web-app#1171
[2] openMF/web-app#1169

Related Pull Requests:
[1] openMF/web-app#1172
[2] openMF/web-app#1170

Known Issues:
Routing to a particular notification is blocked.
[1] Web App Ticket
[2] ASF JIRA Ticket

• Master Search Tool.

• Master Search Results Page.

Master Search Results Page

Related Issues:
[1] openMF/web-app#1189

Related Pull Requests:
[1] openMF/web-app#1190

• User Profile.

User Profile Page

Related Issues:
[1] openMF/web-app#1208

Related Pull Requests:
[1] openMF/web-app#1208

• Automate frequently accessed side-nav icons.

Related Issues:
[1] openMF/web-app#1210

Related Pull Requests:
[1] openMF/web-app#1211

• Language and Date Format settings.

Language and Date Format settings have been initialized in the App, however we need to replace all harcoded instances with the centralized settings service.

Related Issues:
[1] openMF/web-app#1213

Related Pull Requests:
[1] openMF/web-app#1214

Refactored and merged reports module.

I had developed Reports Module as a pre-GSoC Contribution.

Related Issues:
[1] openMF/web-app#232
[2] openMF/web-app#628
[3] openMF/web-app#592

Related Pull Requests:
[1] openMF/web-app#561
[2] openMF/web-app#629
[3] openMF/web-app#592

Refactoring and Fixes.

• Permissions, documentations and functionality refactoring.

I had developed the has-permission directive as a pre-GSoC task.

Related Issues:
[1] openMF/web-app#1196
[2] openMF/web-app#721
[3] openMF/web-app#794

Related Pull Requests:
[1] openMF/web-app#1197
[2] openMF/web-app#1199
[3] openMF/web-app#1200
[4] openMF/web-app#1201
[5] openMF/web-app#1202
[6] openMF/web-app#1203
[7] openMF/web-app#1207
[8] openMF/web-app#1226
[9] openMF/web-app#1227
[10] openMF/web-app#722
[11] openMF/web-app#795

• Other miscellaneous refactoring/fixes.

Related Issues:
[1] openMF/web-app#1224
[2] openMF/web-app#1154
[3] openMF/web-app#1116
[4] openMF/web-app#1111

Related Pull Requests:
[1] openMF/web-app#1225
[2] openMF/web-app#1155
[3] openMF/web-app#1117
[4] openMF/web-app#1112

Reviewed pending pull requests as a bonding period task.

• 51 reviewed, 37 merged, 14 closed.

z-conclusion.md

Further work possible for future:

• Runtime Translations can be enabled with Ivy using i18n and @angular/localize.
• Implementing unit and e2e tests using protractor and karma.
• Stricter type checking can spot bugs at compilation itself, no need to build the app during travis we can replace npm run build:prod with ng test and ng e2e once testing suite is in place.
• Replicating the few remaining screens from community app.

Credits

I would like to acknowledge the efforts of following people for authoring the given major software components which could enable me to easily replicate functionality for analogous use cases.

• Jivjyot Singh : Clients View Skeleton, Notes Tab, Data-Tables Tabs, Custom Theming and Mat-Accordian usage.
• Abhay Chawla : Overall Material Stepper Skeleton and delicate functionality in Charges & Interest Rate Chart steps.
• Abhijeet Singh : Add Charge Component.

Overall Experience

I would like to thank Abhay Chawla and Jivjyot Singh for very active mentoring throughout the programme. A special thanks to Ed Cable, Sanyam Goel and Rahul Goel for administrative support and Bharath Gowda for providing clarification with community app use cases. It has been a great experience working with the Mifos community and I am looking forward to continue the same in the future.

Thank you Mifos Initiative and Google Open Source Team for this great opportunity! 👍 🚀