Skip to content

Latest commit

 

History

History
84 lines (48 loc) · 3.74 KB

README.md

File metadata and controls

84 lines (48 loc) · 3.74 KB
Raw

Mifos X Web App Build Status Gitter

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 is a Single-Page App (SPA) written in standard web technologies HTML5, SCSS and TypeScript. It leverages the popular Angular framework and Angular Material for material design components.

Getting started using

The latest code is continuously deployed at https://openmf.github.io/web-app/ whenever a PR is merged into the master branch.

Getting started developing

  1. Ensure you have the following installed in your system:

    git

    npm

  2. Install angular-cli globally.

npm install -g @angular/[email protected]
  1. Clone the project locally into your system.
git clone https://github.com/openMF/web-app.git

  1. cd into project root directory and make sure you are on the master branch.

  2. Install the dependencies.

npm install
  1. To preview the app, run the following command and navigate to http://localhost:4200/.
ng serve

The application is using the development server with basic authentication by default. The credentials for the same are:

Username - mifos
Password - password

Important Note: Please do not make any alterations to these credentials.

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular-CLI README.

Setting up a local server

Follow the given instructions for your operating system to setup a local server for the Mifos X platform.

Windows

Ubuntu

For 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.

By 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.

Want to help? contributions welcome

Want to file a bug, request a feature, contribute some code, or improve documentation? Excellent! Read up on our guidelines for contributing and then check out one of our issues. Make sure you follow the guidelines before sending a contribution!