WordPress for Android

If you're just looking to install WordPress for Android, you can find it on Google Play. If you're a developer wanting to contribute, read on.

Build Instructions

1. Make sure you've installed Android Studio.
2. Install npm using Node Version Manager(nvm), as described in step one from the Block Editor Quickstart guide
3. cd WordPress-Android to enter the working directory.
4. In Android Studio, open the project from the local repository. This will auto-generate local.properties with the SDK location.
5. Recommended: The CI uses JDK11 to build the app and run the tests. Some tests won't pass on the JDK embedded in Android Studio (JDK8). You might want to set JAVA_HOME and JDK location in Android Studio to JDK11.
6. Go to Tools → AVD Manager and create an emulated device.
7. Run.

Notes:

• To use WordPress.com features (signing in with a WordPress.com account, the Reader, Stats, etc.) you need your own WordPress.com OAuth2 client ID and secret. Please read the WordPress.com Authentication guide.
• While loading/building the app in Android Studio, ignore the prompt to update the Gradle plugin version, as that will probably introduce build errors. On the other hand, feel free to update if you are planning to work on ensuring the compatibility of the newer version.

Build and Test

To build, install, and test the project from the command line:

$ ./gradlew assembleWordPressDebug                        # assemble the debug .apk
$ ./gradlew installWordPressDebug                         # install the debug .apk if you have an
                                                                 # emulator or an Android device connected
$ ./gradlew :WordPress:testWordPressDebugUnitTest         # assemble, install and run unit tests
$ ./gradlew :WordPress:connectedWordPressDebugAndroidTest # assemble, install and run Android tests

Running the app

You can sign in with a self-hosted WordPress site or with a WordPress.com account.

To use your own site, choose "Enter your existing site address" on the app start up screen, then enter the URL of your site and your credentials. If you don't have a site, you can create a temporary test site for free at https://jurassic.ninja/.

To use a WordPress.com account, first configure your own OAuth2 credentials by following the WordPress.com Authentication guide, then choose "Log in or sign up with WordPress.com" on the app start up screen.

Directory structure

.
├── libs                    # dependencies used to build debug variants
├── tools                   # script collection
├── gradle.properties       # properties imported by the build script
├── WordPress
│   |-- build.gradle        # main build script
│   └── src
│       ├── androidTest     # Android test assets, resources and code
│       ├── test            # Unit tests
│       ├── main
│       │   ├── assets      # main project assets
│       │   ├── java        # main project java code
│       │   └── res         # main project resources
│       ├── debug           # debug variant
│       └── release         # release variant

Google Configuration

Google Sign-In is only available for WordPress.com accounts through the official app. Contributors can build and run the app without issue, but Google Sign-In will always fail. Google Sign-In requires configuration files which contain client and server information that can't be shared publicly. More documentation and guides can be found on the Google Identity Platform website.

Contributing

Read our Contributing Guide to learn about reporting issues, contributing code, and more ways to contribute.

Security

If you happen to find a security vulnerability, we would appreciate you letting us know at https://hackerone.com/automattic and allowing us to respond before disclosing the issue publicly.

Getting in Touch

If you have questions or just want to say hi, join the WordPress Slack and drop a message on the #mobile channel.

Documentation

• WordPress.com Authentication - configuring your own OAuth2 credentials
• Coding Style - guidelines and validation and auto-formatting tools
• Pull Request Guidelines - branch naming and how to write good pull requests

Please read the docs for more.

Resources

• WordPress Mobile Blog
• WordPress Mobile Handbook

License

WordPress for Android is an Open Source project covered by the GNU General Public License version 2. Note: code in the libs/ directory comes from external libraries, which might be covered by a different license compatible with the GPLv2.