woocommerce-ios

A Jetpack-powered companion app for WooCommerce.

Build Instructions

1. Download Xcode

   At the moment WooCommerce for iOS uses Swift 5 and requires Xcode 11.2.1 or newer. Previous versions of Xcode can be downloaded from Apple

2. Clone project in the folder of your preference

   git clone https://github.com/woocommerce/woocommerce-ios.git

3. Enter the project directory

   cd woocommerce-ios

4. Install the third party dependencies and tools required to run the project

   We use a few tools to help with development. To install or update the required dependencies, run:

   rake dependencies

5. Open the project by double clicking on WooCommerce.xcworkspace file, or launching Xcode and choose File > Open and browse to WooCommerce.xcworkspace

Credentials for external contributors

In order to login to WordPress.com using the app:

1. Create a WordPress.com account (if you don't already have one).
2. Create a new developer application here.
3. Set "Redirect URLs" = https://localhost and "Type" = Native and click Create then Update.
4. Copy the Client ID and Client Secret from the OAuth Information. Build the app.
5. Navigate to WooCommerce/DerivedSources/ApiCredentials.swift
6. Fill in the dotcomAppId with the Client ID
7. Fill in the dotcomSecret with the Client Secret
8. Recompile and run the app on a device or inside simulator.

Please, remember to not add this information on your commits and PRs.

SwiftLint

We use SwiftLint to enforce a common style for Swift code. The app should build and work without it, but if you plan to write code, you are encouraged to run it locally by rake lint (first run will install SwiftLint if you don't have it). No pull requests should have lint warnings or errors before merging, and we also have Hound (mentioned below) to help us in pull requests on GitHub.

If your code has any style violations, you can try to automatically correct them by running:

rake lint:autocorrect

Otherwise, you can also fix them manually.

CocoaPods

The woocommerce-ios project uses CocoaPods to manage third party libraries.
Third party libraries and resources managed by CocoaPods will be installed by the bundle exec pod install command above.

Peril

The woocommerce-ios project uses Peril to enforce Pull Request guidelines.

Circle CI

The woocommerce-ios project uses Circle CI for continuous integration.

Hound

The woocommerce-ios project uses Hound to enforce basic Swift styles. (Not all Woo styles are defined in Hound.)

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: docs.woocommerce.com

General usage and development questions:

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

Resources

• Documentation on our architecture and frameworks
• Mobile blog
• WooCommerce API Documentation (currently v3)

License

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