{"id":25144501,"url":"https://github.com/openmf/webapp-microfrontends","last_synced_at":"2025-04-28T11:21:03.816Z","repository":{"id":233488190,"uuid":"683159160","full_name":"openMF/webapp-microfrontends","owner":"openMF","description":"The Mifos X Web App - Microfrontends uses a microfrontend architecture to deliver a modular, scalable, and customizable financial inclusion solution.","archived":false,"fork":false,"pushed_at":"2024-08-16T08:49:14.000Z","size":13556,"stargazers_count":3,"open_issues_count":4,"forks_count":7,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-30T09:05:13.212Z","etag":null,"topics":["angular","angularmaterial","html","javascript","microfront-end","scss","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openMF.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-25T18:32:11.000Z","updated_at":"2025-02-03T22:08:47.000Z","dependencies_parsed_at":"2024-08-11T18:57:08.286Z","dependency_job_id":null,"html_url":"https://github.com/openMF/webapp-microfrontends","commit_stats":null,"previous_names":["openmf/webapp-microfrontends"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openMF%2Fwebapp-microfrontends","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openMF%2Fwebapp-microfrontends/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openMF%2Fwebapp-microfrontends/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openMF%2Fwebapp-microfrontends/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openMF","download_url":"https://codeload.github.com/openMF/webapp-microfrontends/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251302769,"owners_count":21567601,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","angularmaterial","html","javascript","microfront-end","scss","typescript"],"created_at":"2025-02-08T19:46:34.928Z","updated_at":"2025-04-28T11:21:03.796Z","avatar_url":"https://github.com/openMF.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mifos X Web App [![Build Status](https://travis-ci.com/openMF/web-app.svg?branch=master)](https://travis-ci.com/openMF/web-app) [![Gitter](https://badges.gitter.im/openMF/web-app.svg)](https://gitter.im/openMF/web-app?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n\nMifos 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.\n\nIt is a Single-Page App (SPA) written in standard web technologies [HTML5](http://whatwg.org/html), [SCSS](http://sass-lang.com) and [TypeScript](http://www.typescriptlang.org). It leverages the popular [Angular](https://angular.io/) framework and [Angular Material](https://material.angular.io/) for material design components.\n\n\n## Getting started using\n\nThe latest code is continuously deployed at https://openmf.github.io/web-app/ whenever a PR is merged into the master branch.\n\n\n## Getting started developing\n\n1. Ensure you have the following installed in your system:\n\n    [`git`](https://git-scm.com/downloads)\n\n    [`npm`](https://nodejs.org/en/download/)\n\n2. Install [angular-cli](https://github.com/angular/angular-cli) globally.\n```\nnpm install -g @angular/cli@14.2.12\n```\n\n3. Clone the project locally into your system.\n```\ngit clone https://github.com/openMF/web-app.git\n```\n\n4. `cd` into project root directory and make sure you are on the master branch.\n\n5. Install the dependencies.\n```\nnpm install\n```\n\n6. To preview the app, run the following command and navigate to `http://localhost:4200/`.\n```\nng serve\n```\n\nThe application is using the development server with basic authentication by default. The credentials for the same are:\n \n    Username - mifos\n    Password - password\n\n**Important Note:** Please do not make any alterations to these credentials.\n\n### Development server\n\nRun `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.\n\n### Code scaffolding\n\nRun `ng generate component component-name` to generate a new component. You can also use\n`ng generate directive|pipe|service|class|guard|interface|enum|module`.\n\n### Build\n\nRun `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--configuration production` flag for a production build.\n\nRun `npm run build:prod` to build a production artifacts Instead.\n\n### Further help\n\nTo get more help on the Angular CLI use `ng help` or go check out the\n[Angular-CLI README](https://github.com/angular/angular-cli).\n\n\n## Setting up a local server\n\nFollow the given instructions for your operating system to setup a local server for the Mifos X platform.\n\n[Windows](https://cwiki.apache.org/confluence/display/FINERACT/Fineract-platform+Installation+on+Windows)\n\n[Ubuntu](https://cwiki.apache.org/confluence/display/FINERACT/Fineract+Installation+on+Ubuntu+Server)\n\nFor connecting to server running elsewhere update the base API URL and/or tenant identifier property in the `environments/environment.ts` file and `environments/environment.prod.ts` file for development and production use respectively.\n\nBy default OAuth2 is disabled. To enable it, change the value of oauth.enabled property to true in the `environments/environment.ts` file and `environments/environment.prod.ts` file for development and production use respectively.\n\n### Docker\n\n\nTo locally build this Docker image from source (after `git clone` this repo), run:\n```\ndocker build -t openmf/web-app:latest .\n```\nYou can then run a Docker Container from the image above like this:\n```\ndocker run -d -p 4200:80 openmf/web-app:latest\n```\n\nAccess the webapp on http://localhost:4200 in your browser.\n\n### Docker compose\nIt is possible to do a 'one-touch' installation of Mifos X Web App using containers (AKA \"Docker\").\nFineract now packs the Mifos community-app web UI in it's docker deploy.\n\nAs Prerequisites, you must have `docker` and `docker-compose` installed on your machine; see\n[Docker Install](https://docs.docker.com/install/) and\n[Docker Compose Install](https://docs.docker.com/compose/install/).\n\nNow to run a new MifosX Web App instance you can simply:\n\n1. `git clone https://github.com/openMF/web-app.git ; cd web-app`\n1. for windows, use `git clone https://github.com/openMF/web-app.git --config core.autocrlf=input ; cd web-app`\n1. `docker-compose up -d`\n1. Access the webapp on http://localhost:4200 in your browser.\n\nYou can also setup different configurations for the MifosX Web App using environment variables:\n\n1. Use environment variables (best choice if you run with Docker Compose):\n\nFineract backend settings\n```\nFINERACT_API_URLS\n```\nValue to set a Fineract server list (environments) to be used, Default value:\n```\nhttps://dev.mifos.io,https://demo.mifos.io,https://qa.mifos.io,https://staging.mifos.io,https://mobile.mifos.io,https://demo.fineract.dev,https://localhost:8443\n```\n\n```\nFINERACT_API_URL\n```\nDefault value used from the Fineract server list. Default value:\n```\nhttps://localhost:8443\n```\n\n```\nFINERACT_PLATFORM_TENANT_IDENTIFIER\n```\nFineract Tenant identifier to be used by default, It must be aligned with the Fineract `tenants` table. Default value:\n```\ndefault\n```\n\n```\nFINERACT_PLATFORM_TENANTS_IDENTIFIER\n```\nFineract Tenant identifier list to be used, Those must be aligned with the Fineract `tenants` table. \n\n\nSetting for Languages (i18n) still under development\n```\nMIFOS_DEFAULT_LANGUAGE=en-US\n```\n```\nMIFOS_SUPPORTED_LANGUAGES=cs-CS,de-DE,en-US,es-MX,fr-FR,it-IT,ko-KO,lt-LT,lv-LV,ne-NE,pt-PT,sw-SW\n```\nThese are the Language available now:\n\n```\nMIFOS_SESSION_IDLE_TIMEOUT=300000\n```\nTime in milliseconds for Session idle timeout, default 300000 seconds\n\n\n|  Language  | Code |    File    |\n|:----------:|:----:|:----------:|\n| Czech      |  cs  | cs-CS.json |\n| German     |  de  | de-DE.json |\n| English    |  en  | en-US.json |\n| Spanish    |  es  | es-MX.json |\n| French     |  fr  | fr-FR.json |\n| Italian    |  it  | it-IT.json |\n| Korean     |  ko  | ko-KO.json |\n| Lithuanian |  li  | li-LI.json |\n| Latvian    |  lv  | lv-LV.json |\n| Nepali     |  ne  | ne-NE.json |\n| Portuguese |  pt  | pt-PT.json |\n| Swahili    |  sw  | sw-SW.json |\n\n\nSetting for applying the Client preload in the Clients view, Default true\n```\nMIFOS_PRELOAD_CLIENTS=false\n```\n\n\nSetting for exporting report table to CSV file using this field delimiter\n```\nMIFOS_DEFAULT_CHAR_DELIMITER=,\n```\n\n\nSetting for Wait time in seconds for reading the user notifications, Default 60 seconds\n```\nMIFOS_WAIT_TIME_FOR_NOTIFICATIONS=60\n```\n\nSetting for Wait time in seconds for reading the COB Catch-Up status, Default 30 seconds\n```\nMIFOS_WAIT_TIME_FOR_CATCHUP=30\n```\n\n\nFor more information look the env.sample file in the root directory of the project\n\n## Want to help? [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/openMF/web-app/issues)\n\nWant to file a bug, request a feature, contribute some code, or improve documentation? Excellent! Read up on our guidelines for [contributing](.github/CONTRIBUTING.md) and then check out one of our [issues](https://github.com/openMF/web-app/issues). Make sure you follow the guidelines before sending a contribution!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenmf%2Fwebapp-microfrontends","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenmf%2Fwebapp-microfrontends","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenmf%2Fwebapp-microfrontends/lists"}