Android - Prerequisites
Before you clone the DevApp or write your first line of code, your machine, your network, and your Q2 accounts all need to be ready. This section walks through every requirement so you can begin development without hitting an unexpected wall on day one.
This section is written for anyone preparing to develop a Q2 Mobile SDK module — including IT staff, project managers, and engineers who are new to Android. If you have shipped Android apps before and already have a working setup, you can skim each page and skip to DevApp Setup. If this is your first Android project, or you work in an organization with strict firewall and software-approval policies, read every page in order.
What you need before development can start
Five things must be in place before any code can build and run:
- A supported computer — meets the OS, RAM, and disk requirements.
- Required software installed — Android Studio, a JDK, and Git.
- Network access — your firewall allows the hosts Q2's tooling needs to reach.
- Q2 accounts and credentials — a
code.q2developer.comaccount, a Personal Access Token, and a sandbox environment URL. - A way to run the app — a physical Android device or the bundled emulator.
Each requirement has its own page in this section.
Pages in this section
| Page | What it covers |
|---|---|
| System Requirements | Supported operating systems, RAM, disk, and hardware (including Apple Silicon). |
| Tools and Software | Android Studio, JDK 21, Git, and optional tools like jenv. |
| Network and Firewall | The exact hosts and ports your network must allow. Hand this page to your IT team if you work behind a corporate firewall. |
| Accounts and Access | Getting a Q2 GitLab account, generating a Personal Access Token, and obtaining your sandbox URL. |
| Pre-Development Checklist | A printable yes/no list to confirm every prerequisite is met before you move on to installation. |
What's next
Start with System Requirements and work through each page in order. The Pre-Development Checklist at the end gives you a single yes/no list to confirm every prerequisite is met. Once it is fully checked off, move to DevApp Setup to clone the repository and run the app for the first time.
If something on these pages is blocked by your organization (for example, your IT team won't approve a host or a tool), reach out to your Q2 contact before continuing. Skipping a prerequisite almost always causes a confusing failure later.