WordPress for Android
Switch branches/tags
Clone or download
Latest commit f5ad12a Sep 21, 2018
Permalink
Failed to load latest commit information.
.github Removing Needs Review: Aug 3, 2016
.idea Allign kotlin code rules with ktlint Aug 31, 2018
WordPress Solve merge conflicts Sep 21, 2018
config added new checkstyle rule to avoid further importing android.app.Frag… Sep 3, 2018
fastlane Merge release/10.8 into release/10.9 Sep 11, 2018
gradle/wrapper Update Gradle wrapper to 4.4 Mar 28, 2018
keystore first BUCK integration Apr 13, 2015
libs Add the missing event string Sep 18, 2018
tools updated google-services.json file checksum Jul 11, 2018
.editorconfig Squashed 'libs/login/' changes from 0f85054215..3d1d5e57f6 Apr 17, 2018
.gitattributes move new editor logic to a fragment Feb 4, 2015
.gitignore Adds tooling for txt to po generation for store metadata strings Jun 25, 2018
.travis.yml Merge pull request #7883 from wordpress-mobile/danger-integration Jun 13, 2018
CODE-OF-CONDUCT.md Updated Code of Conduct with contact information Feb 10, 2017
CODESTYLE.md initial commit of CODESTYLE.md Jun 23, 2014
CONTRIBUTING.md New paragraph describing our naming convetion for icons Apr 5, 2017
Dangerfile Adds Danger initial configuration Jun 11, 2018
Gemfile Fastlane setup for metadata supply Jun 21, 2018
Gemfile.lock Update release notes for 10.9 Sep 12, 2018
LICENSE.md Squashed 'libs/login/' changes from 1f2c781..6a9f1d3 Oct 17, 2017
README.md Update readme to use existing numbered reference-style links Sep 14, 2018
build.gradle bump FluxC version Sep 18, 2018
gradle.properties-example Fix invalid attribute crash when initializing Zendesk Jun 29, 2018
gradlew Squashed 'libs/utils/' changes from 6f09341a9b..452a7a9caa Apr 7, 2017
gradlew.bat Squashed 'libs/utils/' changes from 6f09341a9b..452a7a9caa Apr 7, 2017
settings.gradle Updated dependencies. Feb 22, 2018

README.md

WordPress for Android

Build Status

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 JDK 8 and Android Studio, a Standard Setup would work.
  2. Clone this GitHub repository.
  3. Copy gradle.properties-example to gradle.properties.
  4. In Android Studio open the project from the local repository as a Gradle project (this will auto-generate local.properties with the SDK location).
  5. Make sure you have an emulation device setup in AVD Manager (Tools → Android → AVD Manager).
  6. Run.

Notes:

  • To use WordPress.com features (login to WordPress.com, access Reader and Stats, etc) you need a WordPress.com OAuth2 ID and secret. Please read the OAuth2 Authentication section.

Once installed, you can now build, install and test the project from the command line:

$ ./gradlew assembleVanillaDebug                        # assemble the debug .apk
$ ./gradlew installVanillaDebug                         # install the debug .apk if you have an
                                                        # emulator or an Android device connected
$ ./gradlew :WordPress:testVanillaDebugUnitTest         # assemble, install and run unit tests
$ ./gradlew :WordPress:connectedVanillaDebugAndroidTest # assemble, install and run Android tests

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
│       └── wasabi          # wasabi variant specific resources and manifest

OAuth2 Authentication

In order to use WordPress.com functions you will need a client ID and a client secret key. These details will be used to authenticate your application and verify that the API calls being made are valid. You can create an application or view details for your existing applications with our WordPress.com applications manager.

When creating your application, you should select "Native client" for the application type. The applications manager currently requires a "redirect URL", but this isn't used for mobile apps. Just use "https://localhost".

Once you've created your application in the applications manager, you'll need to edit the ./gradle.properties file and change the WP.OAUTH.APP_ID and WP.OAUTH.APP_SECRET fields. Then you can compile and run the app on a device or an emulator and try to login with a WordPress.com account. Note that authenticating to WordPress.com via Google is not supported in development builds of the app, only in the official release.

Note that credentials created with our WordPress.com applications manager allow login only and not signup. New accounts must be created using the official app or on the web. Login is restricted to the WordPress.com account with which the credentials were created. Also, you will be able to interact with sites of that same WordPress.com account only. In other words, if the credentials were created with foo@email.com, you will only be able to login with foo@email.com and access foo@email.com sites. Using another account like bar@email.com will cause the Client cannot use "password" grant_type error.

Read more about OAuth2 and the WordPress.com REST endpoint.

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.

How we work

You can read more about Code Style Guidelines we adopted, and how we're organizing branches in our repository in the Contribution Guide.

Need help to build or hack?

Say hello on our Slack channel: #mobile.

FAQ

  • Q: I can't build/test/package the project because of a PermGen space error.
  • A: Create a gradle.properties file in the project root directory with the following: org.gradle.jvmargs=-XX:MaxPermSize=1024m.

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.