Skip to content

Latest commit

 

History

History
179 lines (110 loc) · 7.16 KB

README.md

File metadata and controls

179 lines (110 loc) · 7.16 KB
Raw

MifosX Community App Join the chat at https://gitter.im/openMF/community-app Build Status Docker Hub Docker Build

This is the default web application built on top of the MifosX platform for the mifos user community. It is a Single-Page App (SPA) written in web standard technologies like JavaScript, CSS and HTML5. It leverages common popular frameworks/libraries such as AngularJS, Bootstrap and Font Awesome.

Online Demo

Access the online demo version here

Building from source

  1. Ensure you have

Note: On Ubuntu Linux you can use sudo apt-get install npm nodejs-legacy, which avoids the /usr/bin/env: node: No such file or directory problem.

Note that on Linux distributions you'll need to install the Ruby Development package (e.g. sudo dnf install ruby-devel on Fedora), and not just ruby, otherwise bundle install below will fail when it gets to installing ffi which uses native extensions.

  1. Clone this repository to your local filesystem (default branch is 'develop'):

     git clone https://github.com/openMF/community-app.git

  2. To download the dependencies, and be able to build, first install bower & grunt:

     npm install -g bower
 npm install -g grunt-cli

If this fails with npm WARN checkPermissions Missing write access to /usr/local/lib and npm ERR! code EACCES because you are not running npm with sudo as root (which you rightfully really shouldn't!) then use npm config set prefix ~ once before doing npm install. Note that in that case bower and grunt will be installed into ./bin/bower instead of /usr/local/bin, and so you need to prefix it in the usages below.

  1. Next pull the runtime and build time dependencies by running bower, npm, and gem commands on the project root folder:

     bower install

For Windows PC, before you run npm install check in the root folder if any package-lock.json is generated and delete it then you can run npm install other wise you will be faced with Npm ERR! code EPERM error errno -4048 error { Error: EPERM: operation not permitted, rename .... a permission error even if you are using administrator user

 npm install

 gem install bundler

 bundle install

If you used npm config set prefix ~, then you have to use ./bin/bower install instead of bower install.

  1. To preview the app, run the following command on the project root folder:

     grunt serve

    If you used npm config set prefix ~, then you have to use ./bin/grunt serve instead of grunt serve.

    or open the 'index.html' file in FIREFOX browser

    Note: If you see a warning similar to the one shown below on running grunt serve , try increasing the number of open files limit as per the suggestions at http://stackoverflow.com/questions/34588/how-do-i-change-the-number-of-open-files-limit-in-linux/

     Waiting...Warning: EMFILE, too many open files

  2. You can use these credentials to log in:

     Username: mifos
 Password: password

You are done.

Connecting to a MifosX Platform using OAuth 2 authentication:

Edit the value of property "security" in configurations.js to "oauth"

Connecting to a MifosX Platform running on a different host:

By default, when the app is running from the local filesystem, it will connect to the platform (fineract-provider REST API) deployed on demo.mifos.io.

The app connects to the platform running on the same host/port when deployed on a server.

If you are running the Fineract backend locally, for the first time or have cleared the cookies from your browser, you will need to first bypass the security warning by accepting the SSL in your browser with:

https://localhost:8443/fineract-provider/api/v1&tenantIdentifier=default

If you want to connect to the API running elsewhere, then append the baseApiUrl and tenantIdentifier as query parameters,

e.g. http://localhost:9002/?baseApiUrl=https://localhost:8443&tenantIdentifier=default

e.g. http://localhost:9002/?baseApiUrl=https://demo.mifos.io&tenantIdentifier=default

Adding dependencies

You can also add more dependencies on bower.json. You can search for them in http://sindresorhus.com/bower-components/ or even:

bower search <package>

Running grunt tasks

Grunt tasks are used to automate repetitive tasks like minification, compilation, unit testing, linting, production builds, etc

Following are the tasks integrated.

Validate JS and HTML files

Validate the JS files to detect errors and potential problems in JavaScript code. All errors output will be written to jshint-log.xml file which get created under project base directory. Checks the markup validity of HTML files. All errors output will be written to console.

grunt validate

Build

Build the code for production deployment.

grunt prod

Serve

Use this for development. Start a static server and open the project in the default browser. The application will hit the demo server.

grunt serve

Docker

This project publishes a Docker image (since #3112) available on https://hub.docker.com/r/openmf/community-app/. Our Dockerfile uses a Ruby and Node.JS base image to build the current repo and deploy the app on Nginx, which is exposed on port 80 within the container. It can be used like this to access the webapp on http://localhost:9090 in your browser:

docker run --name community-app -it -p 9090:80 openmf/community-app

To locally build this Docker image from source (after git clone this repo), run:

docker build -t mifos-community-app .

You can then run a Docker Container from the image above like this:

docker run --name mifos-ui -it -d -p 80:80 mifos-community-app

Access the webapp on http://localhost in your browser.

Compile sass to css

grunt compass:dev

Running the tests

Just open test/SpecRunner.html in the browser.

Getting Started doc

https://docs.google.com/document/d/1oXQ2mNojyDFkY_x4RBRPaqS-xhpnDE9coQnbmI3Pobw/edit#heading=h.vhgp8hu9moqn

Contribution guidelines

Please read the contribution guidelines

Note: This application will hit the demo server by default.