This guide was written for our participation in Code for Good Week Hosted By SFHTML5 but has been repurposed as a starting point for new technical contributors to Mifos X and Apache Fineract.

C4GW is an initiative dedicated to bringing together web developers, designers, technical writers, and other technologists to discover and contribute to open source projects for civic engagement or social good. The goals of the effort are to help the community learn about and effectively contribute to open source projects.

We've been invited as one of three organizations to participate in the Code for Good Week hosted by SFHTML5, the largest web development meetup group in the world. More than 20,000 developers could be participating in this online and on-site hackathon taking place from July 27 to Aug 3.

For more detailed about who we are and what we do, please see http://mifos.org/

Lightning-Fast Quick Start!

Who We Are and What We Do
- Official Site - https://mifos.org/mifos-initiative/
- Financial Inclusion - What is Financial Inclusion?
Get the Code
- Web App - https://github.com/openMF/web-app
- Community App - https://github.com/openMF/community-app
- Online Banking App - https://github.com/openMF/web-self-service-app
- Platform, Mobile Apps & More: (scroll down)
Find a Task to Work On:
- Front-End: https://github.com/orgs/openMF/projects/1
- Fineract: https://goo.gl/f5NgHy
Get Started:
- Web App - https://github.com/openMF/web-app/blob/master/.github/CONTRIBUTING.md
- Community App - https://github.com/openMF/community-app/blob/develop/Contributing.md
- API Docs: https://demo.openmf.org/api-docs/apiLive.htm
Get Some Help:
- See New Contributor Getting Started Guide#Communication: (scroll down)

Documentation

General

Mifos X Web App

Build/Environment/Installation Setup Instructions

Github Repository : https://github.com/openMF/web-app
Building Web App From Source : https://github.com/openMF/web-app/blob/master/README.md
Getting Started : https://github.com/openMF/web-app/wiki/Replicate-an-existing-Community-App-screen-into-the-new-Web-App

Demo: https://openmf.github.io/web-app/

Guidelines

Contribution Guidelines : https://github.com/openMF/web-app/blob/master/.github/CONTRIBUTING.md

Mifos X Android Field Operations App

Build/Environment/Installation Setup Instructions

Source Code : https://github.com/openMF/android-client
Setup Git and Github : https://github.com/openMF/mifosx/wiki/Github-&-Git
Setup Android Studio : https://github.com/openMF/android-client/wiki/Android-Studio-Setup
Building Up The Code : https://github.com/openMF/android-client/wiki/Building-up-Code

Roadmaps : https://mifosforge.jira.com/wiki/spaces/MIFOSX/pages/34111558/Usability+and+Design

Mifos Mobile

Build/Environment/Installation Setup Instructions

Source Code : http://github.com/openMF/self-service-app/
Setup Git and Github : https://github.com/openMF/mifosx/wiki/Github-&-Git
Setup Android Studio : https://github.com/openMF/android-client/wiki/Android-Studio-Setup
Building Up The Code : https://github.com/openMF/android-client/wiki/Building-up-Code

Coding Standards & Guidelines

Commit Style Guideline : https://github.com/openMF/self-service-app/wiki/Commit-Style-Guide
Contributors : https://github.com/openMF/self-service-app/blob/development/.github/CONTRIBUTING.md

Roadmaps : https://mifosforge.jira.com/wiki/spaces/projects/pages/184139456/Self-Service+Android+Application+Roadmap

Communication

There are three main ways that Mifos volunteers and G4GW participants communicate with eachother :

Mifos Slack Channel : mifos.slack.com
- E-mail edcable@mifos.org if you'd like to join.
Mifos Gitter Channel : https://gitter.im/openMF/mifos
- Web App - https://gitter.im/openMF/web-app
- Community App - https://gitter.im/openMF/community-app
- Online Banking App - https://gitter.im/openMF/web-self-service-app
Mifos Mailing Lists : http://mifos.org/resources/community/communications/#mailing-lists

Code Of Conduct

The Mifos community comprises of a large number of experts, students, and professionals from around the world. We come from varied backgrounds, fields, and countries, and are all tied together by our desire to do good. Because the community is so diverse and spread across the globe, please remember to be courteous and considerate to other community members at all times. Always remember that people may be based in other timezones, and may have other jobs that they prioritize. For more information, please refer to our community code of conduct.

For best practices in using our GitHub repos, please read our Coding Standards and use the Mifos Coding Style Guide .

Also adhere to C4GW's code of Conduct used during live events.

New Contributor Getting Started Guide