for iOS
A Jetpack-powered companion app for WooCommerce.
Build Instructions • Documentation • Contributing • Automation • Security • Need Help? • Resources • License
🎉 Build Instructions
- Download Xcode
- Install Ruby. We recommend using rbenv to install it. Please refer to the
.ruby-versionfile for the required Ruby version.
- Clone project in the folder of your preference
git clone https://github.com/woocommerce/woocommerce-ios.git
- Enter the project directory
cd woocommerce-ios
- Install the third party dependencies and tools required to run the project.
brew install xz && bundle install && bundle exec rake dependencies
This command installs the required build tools and dependencies.
a8c-secrets; the command above then decrypts the project secrets.
Re-run it, or a8c-secrets decrypt, whenever the secrets are rotated.
- 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:
- Create a WordPress.com account (if you don't already have one).
- Create a new developer application here.
- Set "Website URL" =
http://www.wordpress.com, "Redirect URLs" = https://localhost, "Javascript Origins" = https://localhost and "Type" = Native and click Create. On the next page, click Update.
Copy the Client ID and Client Secret from the OAuth Information.
Open WooCommerce/Credentials/Templates/ApiCredentials-Template.swift.
Fill in the dotcomAppId with the Client ID.
Fill in the dotcomSecret` with the Client Secret.
Please, remember to not add this information on your commits and PRs.
📚 Documentation
- Architecture
- Coding Guidelines
- Design Patterns
- Quality & Testing
- Features
- Other
👏 Contributing
Read our Contributing Guide to learn about reporting issues, contributing code, and more ways to contribute.
🤖 Automation
Peril
The woocommerce-ios project uses Peril to enforce Pull Request guidelines.
Circle CI
The woocommerce-ios project uses Circle CI for continuous integration.
🔐 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
📜 License
WooCommerce for iOS is an Open Source project covered by the GNU General Public License version 2.
Made with 💜 by WooCommerce.
We're hiring! Come work with us!