Project Setup

Prerequisites

Make sure to install all tools and IDE such as Android Studio & XCode (Refer to Environment Setup Guide for more information.

Step 1: Fork the Repository

• Navigate to the Android Client GitHub repository
• Click the "Fork" button in the top right corner
• This creates a copy of the project under your GitHub account

Step 2: Clone Your Forked Repository

Once you have forked the repository, you must clone it to your local development environment. follow the below steps on how to open your repository in Android Studio.

• Open Android Studio
• Go to File --> New --> Project From Version Control or If you freshly opened your IDE then click on Clone Repository
• Clone Repository Wizard Will be open, paste your forked repository URL in the URL box like https://github.com/openMF/android-client.git
• Click Clone to Save on your machine and open the project.

Tip

It is recommended to wait until the build to finished before making any changes to the code.

Step 3: Set Up Your Development Branch

After the successful build, and before making any changes, create a new branch dedicated to the feature or bug fix you'll be working on:

• Navigate to VCS --> New Branch
• Create a New Branch Dialog will be open
• Enter the branch name

Ensure that new-branch-name reflects the purpose of your changes (e.g., add-payment-feature or fix-bug-123). Make the necessary changes to the files to address the issue you're working on. Once you're done, you will be ready to proceed with verifying and committing your changes.

---