<h1 align="center"><img src="docs/images/logo-woo.svg" width="300"><br>for iOS</h1>
<p align="center">A Jetpack-powered companion app for WooCommerce.</p>
<p align="center">
<a href="https://buildkite.com/automattic/woocommerce-ios">
<img src="https://badge.buildkite.com/5ad3c27f663ae4f3a3b443c1f7a5ca20e737ffe78aad15e1ec.svg?branch=trunk">
</a>
<a href="https://github.com/woocommerce/woocommerce-ios/releases">
<img alt="Release" src="https://img.shields.io/github/v/tag/woocommerce/woocommerce-ios?label=release&sort=semver">
</a>
<a href="https://github.com/woocommerce/woocommerce-ios/blob/trunk/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/woocommerce/woocommerce-ios">
</a>
</p>
<p align="center">
<a href="#-build-instructions">Build Instructions</a> •
<a href="#-documentation">Documentation</a> •
<a href="#-contributing">Contributing</a> •
<a href="#-automation">Automation</a> •
<a href="#-security">Security</a> •
<a href="#-need-help">Need Help?</a> •
<a href="#-resources">Resources</a> •
<a href="#-license">License</a>
</p>
## 🎉 Build Instructions
1. Download Xcode
At the moment *WooCommerce for iOS* uses Swift 5.7 and requires Xcode 14 or newer. Previous versions of Xcode can be [downloaded from Apple](https://developer.apple.com/downloads/index.action).
2. Install Ruby. We recommend using [rbenv](https://github.com/rbenv/rbenv) to install it. Please refer to the [`.ruby-version` file](.ruby-version) for the required Ruby version.
We use Ruby to manage the third party dependencies and other tools and automation.
2. Clone project in the folder of your preference
```bash
git clone https://github.com/woocommerce/woocommerce-ios.git
````
3. Enter the project directory
```bash
cd woocommerce-ios
```
4. Install the third party dependencies and tools required to run the project.
```bash
brew install xz && bundle install && bundle exec rake dependencies
```
This command installs the required build tools and dependencies.
Automattic contributors should first install and set up [`a8c-secrets`](https://github.com/Automattic/a8c-secrets); the command above then decrypts the project secrets.
Re-run it, or `a8c-secrets decrypt`, whenever the secrets are rotated.
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](https://wordpress.com/start/user) (if you don't already have one).
2. Create a new developer application [here](https://developer.wordpress.com/apps/).
3. 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**.
4. Copy the *Client ID* and *Client Secret* from the OAuth Information.
5. Open `WooCommerce/Credentials/Templates/ApiCredentials-Template.swift`.
6. Fill in the `dotcomAppId` with the Client ID.
7. Fill in the `dotcomSecret` with the Client Secret.
8. Build and run the app on a device or inside simulator.
The build phase copies this template into each target's derived sources directory on every build, so your edits persist across clean builds.
Please, remember to not add this information on your commits and PRs.
## 📚 Documentation
- Architecture
- [Overview](docs/architecture-overview.md)
- [Networking](docs/NETWORKING.md)
- [Storage](docs/STORAGE.md)
- [Yosemite](docs/YOSEMITE.md)
- [Hardware](docs/HARDWARE.md)
- Coding Guidelines
- [Coding Style](docs/coding-style-guide.md)
- [Naming Conventions](docs/naming-conventions.md)
- [Protocols](docs/naming-conventions.md#protocols)
- [String Constants in Nested Enums](docs/naming-conventions.md#string-constants-in-nested-enums)
- [Test Methods](docs/naming-conventions.md#test-methods)
- [Choosing Between Structures and Classes](docs/choosing-between-structs-and-classes.md)
- [Creating Core Data Model Versions](docs/creating-core-data-model-versions.md)
- [Localization](docs/localization.md)
- [Switch Statements](docs/switch-statements.md)
- Design Patterns
- [Copiable](docs/copiable.md)
- [Generating Copiable Methods](docs/copiable.md#generating-copiable-methods)
- [Modifying The Copiable Code Generation](docs/copiable.md#modifying-the-copiable-code-generation)
- [Fakeable](docs/fakeable.md)
- [Generating Fake Methods](docs/fakeable.md#generating-fake-methods)
- [Modifying Fakes Code Generation](docs/fakeable.md#modifying-the-fakeable-code-generation)
- [Tracking Events](docs/tracking-events.md)
- [Custom Properties](docs/tracking-events.md#custom-properties)
- Quality & Testing
- [AI dev and testing tools](docs/ai-tools.md)
- [UI Tests](WooCommerce/WooCommerceUITests/README.md)
- [Testing Card Present Payments](docs/stripe-tests.md)
- [Beta Testing](https://woocommercehalo.wordpress.com/setup/join-ios-beta/)
- Features
- [In-app Feedback](docs/in-app-feedback.md)
- [Card Present Payments](docs/card-present-payments.md)
- Other
- [Enable hot reload with Inject](docs/inject-hot-reload.md)
## 👏 Contributing
Read our [Contributing Guide](CONTRIBUTING.md) to learn about reporting issues, contributing code, and more ways to contribute.
## 🤖 Automation
### Screenshot generation
Prefer local generation through agents using the [App Store screenshots skill](.agents/skills/app-store-screenshots/SKILL.md) for reliability and speed. The `generate screenshots` CI workflow cannot compose the complete set because its capture jobs exclude Duo.
### Peril
The woocommerce-ios project uses [Peril](https://danger.systems/js/guides/peril.html) to enforce Pull Request guidelines.
### Circle CI
The woocommerce-ios project uses [Circle CI](https://circleci.com/gh/woocommerce/woocommerce-ios) 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](https://docs.woocommerce.com/)
General usage and development questions:
* [WooCommerce Slack Community](https://woocommerce.com/community-slack/)
* [WordPress.org Forums](https://wordpress.org/support/plugin/woocommerce)
* The WooCommerce Help and Share Facebook group
## 🔗 Resources
- [Mobile blog](https://mobile.blog)
- [WooCommerce API Documentation (currently v3)](https://woocommerce.github.io/woocommerce-rest-api-docs/#introduction)
## 📜 License
WooCommerce for iOS is an Open Source project covered by the [GNU General Public License version 2](LICENSE).
<p align="center">
<br/><br/>
Made with 💜 by <a href="https://woocommerce.com/">WooCommerce</a>.<br/>
<a href="https://woocommerce.com/careers/">We're hiring</a>! Come work with us!
</p>