artin/community-app
1
0
Fork 0
mirror of https://github.com/openMF/community-app.git synced 2026-02-06 13:51:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
This is the default web application built on top of the Apache Fineract platform. The Mifos X Web App (formerly called Community App) is maintained by the Mifos Initiative as a reference solution for the financial inclusion 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 1.5, Bootstrap and Font Awesome
1,059 Commits 80 Branches 9 Tags 78 MiB
HTML 52.2%
JavaScript 36%
CSS 10.6%
SCSS 1.2%
8269430a59
Go to file
Vishwas Babu A J 8269430a59 fixing typos in readme
2014-03-11 02:09:22 -07:00
app Add number format for reports and issue #767 2014-03-11 13:02:12 +05:30
test reformatting project 2014-03-02 04:09:27 -08:00
.bowerrc vertical slicing! 2013-09-13 10:49:03 +05:30
.gitignore Fixed running 'bower install' during gradle install WAR build (it didn't 2013-12-06 20:36:21 +01:00
.jshintrc .jshintrc ignore indentation issues - we'd have bigger fish to fry, first 2013-10-20 08:55:00 +02:00
.project Eclipse .project to be able to easily File > Open in E 2013-11-12 11:09:24 +01:00
.travis.yml chelsea and stacey's work around travis email and readme updates 2013-12-20 02:18:37 +05:30
bower.json Auto loguout for idle user 2014-02-27 10:37:39 +05:30
build.gradle Fixed running 'bower install' during gradle install WAR build (it didn't 2013-12-06 20:36:21 +01:00
Contributing.md adds unit test documentation 2013-12-03 16:07:11 -06:00
Gruntfile.js changing host name for grunt serve to 'localhost' 2014-03-11 01:58:50 -07:00
karma-e2e.conf.js Grunt Karm - as proposed by Yeoman (forgot to commit earlier). Not really working as it should, yet 2013-10-20 09:13:24 +02:00
karma.conf.js added other relative paths 2013-12-11 16:09:25 -06:00
package.json Add grunt tasks for easier development 2014-03-04 16:31:04 +01:00
README.md fixing typos in readme 2014-03-11 02:09:22 -07:00

README.md

MifosX Community App

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.

Build Status

Travis

Build Status

Online Demo

Access the online demo version here

Building from source

  1. Note: Ensure you have npm installed - goto http://nodejs.org/download/ to download installer for your OS.

  2. Clone this repository to your local filesystem (default branch in 'develop')

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

npm install -g bower
npm install -g grunt-cli
  1. Next pull the runtime and build time dependencies by running bower and npm install commands on the project root folder:
 bower install

 npm install
  1. To preview the app run
 grunt serve

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

  1. Default username/password: mifos/password. This application will hit the demo server by default.

You are done.

Connecting to a MifosX Platform running on a different host:

By default, when the app is running in the local filesystem or on http://localhost, it will connect to demo.openmf.org. The UI will connect to the mifosng-provider REST API running on the same host/port when running in the cloud.

If you want to connect to the API running elsewhere, then append the baseApiUrl as a query parameter, e.g. http://localhost:9090/app/index.html?baseApiUrl=https://localhost:8443/#/.

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

Running the tests

Just open test/SpecRunner.html in the browser.

Contribution guidelines

Please read the contribution guidelines