New Contributor Getting Started Guide
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:
- Get Some Help:
- See New Contributor Getting Started Guide#Communication: (scroll down)
Documentation
General
- http://mifos.org/resources/technical-resources/
- https://gist.github.com/Chaser324/ce0505fbed06b947d962
- https://mifosforge.jira.com/wiki/spaces/MDZ/pages/90243316/Getting+started
Apache Fineract
- Build/Environment/Installation Setup Instructions
- Take Your First Steps : https://cwiki.apache.org/confluence/display/FINERACT/Take+Your+First+Steps
- Building Apache Fineract : https://github.com/apache/fineract
- API Documentation : https://demo.openmf.org/api-docs/apiLive.htm
- Architectural Overviews :
- Architecture : https://demo.openmf.org/architecture/
- Coding Standards & Guidelines
- Committers : https://cwiki.apache.org/confluence/display/FINERACT/Committer%27s+Zone
- Contributors : https://cwiki.apache.org/confluence/display/FINERACT/Contributor%27s+Zone
- Coding Conventions : https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions
- Coding Standards : https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=68714707
- Design Principles :
- Key Design Principles : https://cwiki.apache.org/confluence/display/FINERACT/Key+Design+Principles
- Contribution / Development Processes
- Installing Fineract Platform : https://cwiki.apache.org/confluence/display/FINERACT/Installing+Fineract-platform
- How To Build Fineract Platform : https://cwiki.apache.org/confluence/display/FINERACT/Build+Instructions
- Coding Processes : https://cwiki.apache.org/confluence/display/FINERACT/Changing+Processes
- Release Processes
- Signing A Release : https://cwiki.apache.org/confluence/display/FINERACT/Release+Sign
- Stabilizing A Release : https://cwiki.apache.org/confluence/display/FINERACT/Stabilizing+a+release
- Verifying Apache Fineract Releases : https://cwiki.apache.org/confluence/display/FINERACT/Verifying+Apache+Fineract+Releases
- Versioning : https://cwiki.apache.org/confluence/display/FINERACT/Versioning
- How To Release Apache Fineract : https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=67640333
- Roadmaps
- Completed Features : https://cwiki.apache.org/confluence/display/FINERACT/Completed+Features
- Features In-progress : https://cwiki.apache.org/confluence/display/FINERACT/In-Progress+Features
- Outstanding Features : https://cwiki.apache.org/confluence/display/FINERACT/Outstanding+Features
Apache Fineract CN
- Build/Environment/Installation Setup Instructions
- Take Your First Steps : https://cwiki.apache.org/confluence/display/FINERACT/Fineract+CN
- Project Structure : https://cwiki.apache.org/confluence/display/FINERACT/Fineract+CN+Project+Structure
- How To Build Apache Fineract CN : https://cwiki.apache.org/confluence/display/FINERACT/How+To+Build+Apache+Fineract+CN
- Working with Gitbox to contribute to FIneract CN : https://cwiki.apache.org/confluence/display/FINERACT/Working+with+gitbox+to+contribute+to+Apache+Fineract+CN
- API Documentation : https://cwiki.apache.org/confluence/display/FINERACT/Apache+Fineract+CN+API+Documentation
- Architectural Overviews :
Mifos X Community App
- Build/Environment/Installation Setup Instructions
- Github Repository : https://github.com/openMF/community-app
- Building Web App From Source : https://github.com/openMF/community-app/blob/develop/README.md
- Getting Started : https://docs.google.com/document/d/1oXQ2mNojyDFkY_x4RBRPaqS-xhpnDE9coQnbmI3Pobw/edit#heading=h.vhgp8hu9moqn
- Architectural Overviews :
- Demo Server : https://demo.openmf.org/
- Coding Standards & Guidelines
- Contribution Guidelines : https://github.com/openMF/community-app/blob/master/Contributing.md
- Features : http://openmf.github.io/community-app/features.html
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
- 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.