WooCommerce Android app
Jetpack-powered WooCommerce Android app codenamed Dervish. If you're just looking to install WooCommerce for Android, you can find it on Google Play. If you're a developer wanting to contribute, read on.
Clone this repository in the folder of your preference, and then enter that folder:
$ git clone https://github.com/woocommerce/woocommerce-android.git $ cd woocommerce-android
Generate the developer oauth2 tokens. These values get copied into the main
gradle.propertiesfile in the next step. See the OAuth2 Authentication section for details.
gradle.propertiesfile for this app:
$ cp ./gradle.properties-example ./gradle.properties
gradle.propertiesfile for the Login Library dependency:
$ cp ./libs/login/gradle.properties-example ./libs/login/gradle.properties
Open and modify the newly created
gradle.propertiesfiles. See the Configuration Files section for a breakdown of the properties.
In Android Studio, open the project from the local repository. This will auto-generate
local.propertieswith the SDK location.
Go to Tools → AVD Manager and create an emulated device.
To 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 a device connected $ ./gradlew :WooCommerce:testVanillaDebugUnitTest # assemble, install and run unit tests $ ./gradlew :WooCommerce:connectedVanillaDebugAndroidTest # assemble, install and run Android tests
The WooCommerce for Android app connects to stores via WordPress.com APIs so if a WooCommerce store is not hosted on WordPress.com, it will require the Jetpack plugin to setup a common interface for communicating with a self-hosted store. In order to use these APIs, 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.
Once you've created your application in the applications manager, you'll need to edit the
./gradle.propertiesfile and change the
wp.oauth.app_secretfields. 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. In other words, if the credentials were created with [email protected], you will only be able to login with [email protected] Using another account like [email protected] will cause the
Client cannot use "password" grant_typeerror.
For security reasons, some account-related actions aren't supported for development builds when using a WordPress.com account with 2-factor authentication enabled.
| Property | Description | |:---------------------------|:------------| |wc.oauth.appid | Required to build the app. See OAuth2 Authentication| | wc.oauth.appsecret | Required to build the app. See OAuth2 Authentication | | wc.zendeskappid | Used for Zendesk integration. Can be ignored.| | wc.zendesk.domain | Used for Zendesk integration. Can be ignored.| | wc.zendesk.oauthclientid | Used for Zendesk integration. Can be ignored.| | wc.resetdbon_downgrade | Debug builds: If
truewill drop all tables and recreate the db if a database downgrade is detected. | | wc.sentry.dsn | Used for Sentry integration. Can be ignored.|
| Property | Description | |:---------------------------|:------------| | wp.debug.wpcomloginemail |Optional: used to autofill email during login on debug build only| | wp.debug.wpcomloginusername|Optional: used to autofill username during login on debug build only| |wp.debug.wpcomloginpassword|Optional: used to autofill password during login on debug build only| |wp.debug.wpcomwebsiteurl|Optional: used to autofill store url during login on debug build only|
The woocommerce-android project uses Checkstyle. You can run checkstyle using
./gradlew checkstyle. You can also view errors and warnings in realtime with the Checkstyle plugin. When importing the project into Android Studio, Checkstyle should be set up automatically. If it is not, follow the steps below.
You can install the CheckStyle-IDEA plugin in Android Studio here:
Android Studio > Preferences... > Plugins > CheckStyle-IDEA
Once installed, you can configure the plugin here:
Android Studio > Preferences... > Other Settings > Checkstyle
From there, add and enable the configuration file for woocommerce-android, located at config/checkstyle.xml.
The woocommerce-android project uses ktlint for Kotlin linting. You can run ktlint using
./gradlew ktlint, and you can also run
./gradlew ktlintFormatfor auto-formatting. There is no IDEA plugin (like Checkstyle's) at this time.
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.
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.
Usage docs can be found here: docs.woocommerce.com
General usage and development questions:
WooCommerce 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.