Skip to content
Branch: develop
Clone or download
ctarda Merge pull request #1114 from woocommerce/issue/1066-stats-yosemite
Stats: add to the Yosemite layer to support new stats
Latest commit 0f05d69 Jul 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github Add RELEASE-NOTES.txt file to encourage adding release notes iteratively Jan 23, 2019
Networking Add tests for updating stats (failing) Jul 17, 2019
Scripts Update localize.py script to handle multiple comments Feb 5, 2019
Storage Add missing methods to coredata extensions and finalise first impleme… Jul 17, 2019
WooCommerce.xcworkspace Update codegen definition in the daa model to None Jul 10, 2019
WooCommerce Merge pull request #1077 from woocommerce/issue/1035-viewmodel Jul 18, 2019
Yosemite Shut up Hound! Jul 18, 2019
config Bump version number Jul 15, 2019
docs Implement PR feedback Jul 17, 2019
fastlane Add automatic dSYM upload to Sentry Jul 15, 2019
.configure Update .configure May 17, 2019
.gitattributes Reduce number of conflicts in RELEASE-NOTES.txt Jan 30, 2019
.gitignore Update gitignore Mar 8, 2019
.hound.yml Change Hound definition from `swift` to `swiftlint` Mar 4, 2019
.swiftlint.yml Run swiftlint on Yosemite project Mar 12, 2019
Gemfile Merge branch 'develop' into remove-cocoapods-check Apr 11, 2019
Gemfile.lock Add automatic dSYM upload to Sentry Jul 15, 2019
LICENSE Initial commit Jan 24, 2018
Podfile Merge branch 'develop' into issue/1025-pod Jun 14, 2019
Podfile.lock Merge branch 'develop' into issue/1025-pod Jun 14, 2019
README.md Update README.md with more detailed information (#1100) Jul 16, 2019
RELEASE-NOTES.txt Dashboard: show/hide visitor stats when Jetpack module is turned on/o… Jul 17, 2019
Rakefile Rakefile: Don't use 'cocoapods-check' to check if pods should be inst… Apr 10, 2019

README.md

CircleCI Reviewed by Hound

woocommerce-ios

A Jetpack-powered companion app for WooCommerce.

Build Instructions

  • Download Xcode
    • At the moment WooCommerce for iOS uses Swift 5 and requires Xcode 10.2 or newer. Previous versions of Xcode can be downloaded from Apple
  • Clone project by git clone https://github.com/woocommerce/woocommerce-ios.git in the folder of your preference
  • Enter the project directory by cd woocommerce-ios
  • 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 the follow command on the command line: bundle exec pod install
    • In some cases, you may also have to: bundle install
  • Open the project by double clicking on WooCommerce.xcworkspace file, or launching Xcode and choose File > Open and browse to WooCommerce.xcworkspace

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:

Resources

License

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

You can’t perform that action at this time.