README.md

for Android

A Jetpack-powered mobile app for WooCommerce.

Setup Instructions • Build & Test • Documentation • Contributing • Automation • Security • Need Help? • Resources • License

🎉 Setup Instructions

1. Make sure you've installed Android Studio.

2. 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

3. Generate the developer oauth2 tokens. These values get copied into the main gradle.properties file in the next step. See the OAuth2 Authentication section for details.

4. Generate the gradle.properties file for this app:

   $ cp ./gradle.properties-example ./gradle.properties

5. Open and modify the newly created gradle.properties files. See the Configuration Files section for a breakdown of the properties.

6. In Android Studio, open the project from the local repository. This will auto-generate local.properties with the SDK location.

7. Optional: Go to Tools → Device Manager and create an emulated device.

8. Run. (Creates a default virtual device if you skipped the previous step)

Build & Test

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

📚 Documentation

• Project Overview
  • OAuth2 Authentication
  • Configuration Files
  • Using Detekt
  • Google Configuration
• Development Practices
  • Coding Style Practices
  • Pull Request Guidelines
  • Material Theme Designs
  • Using Android Resources
  • Localization
  • Themes & Styling Practices
  • Subtree'd Library Projects
• Data
  • Tracking Events
• Accessibility
  • Accessibility Guidelines
  • Right to Left Layout Guidelines
• Quality & Testing
  • Beta Testing
  • Issue Triage
• Features
  • Feature Flags

👏 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.

🦮 Need Help?

You can find the WooCommerce usage docs here: woo.com/documentation/woocommerce/

General usage and development questions:

• WooCommerce Slack Community
• WordPress.org Forums
• The WooCommerce Help and Share Facebook group

🔗 Resources

• Mobile blog
• WooCommerce API Documentation (currently v3)

📜 License

WooCommerce for Android is an Open Source project covered by the GNU General Public License version 2.

📚 Proprietary Libraries

In order to offer a great experience to our users, we use some proprietary libraries that are not open source. These libraries are:

• ML Kit for barcode scanning and text recognition. You can find its Terms of Service here.

Made with 💜 by WooCommerce.
We're hiring! Come work with us!