https://github.com/wordpress-mobile/wordpress-ios
WordPress for iOS - Official repository
https://github.com/wordpress-mobile/wordpress-ios
cocoapods ios objective-c swift wordpress xcode
Last synced: 14 days ago
JSON representation
WordPress for iOS - Official repository
- Host: GitHub
- URL: https://github.com/wordpress-mobile/wordpress-ios
- Owner: wordpress-mobile
- License: gpl-2.0
- Created: 2013-03-18T16:59:33.000Z (about 12 years ago)
- Default Branch: trunk
- Last Pushed: 2024-10-29T13:13:40.000Z (6 months ago)
- Last Synced: 2024-10-29T13:35:45.393Z (6 months ago)
- Topics: cocoapods, ios, objective-c, swift, wordpress, xcode
- Language: Swift
- Homepage: http://ios.wordpress.org/
- Size: 2.39 GB
- Stars: 3,688
- Watchers: 178
- Forks: 1,117
- Open Issues: 981
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# WordPress for iOS #
## Build Instructions
Please refer to the sections below for more detailed information. The instructions assume the work is performed from a command line inside the repository.
### Getting Started
1. [Download](https://developer.apple.com/downloads/index.action) and install Xcode. Refer to the [.xcode-version](./.xcode-version) file for the minimum required version.
1. [Clone this repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) in the folder of your preference.
1. Run `rake dependencies`.
#### Create WordPress.com API Credentials
1. Create a WordPress.com account at https://wordpress.com/start/user (if you don't already have one).
1. Create an application at https://developer.wordpress.com/apps/.
1. Set **Website URL** to any valid host, **Redirect URLs** to `https://localhost`, and **Type** to `Native`.
1. Click "Create" then "Update".
1. Copy the `Client ID` and `Client Secret` from the OAuth Information.
#### Configure Your WordPress App Development Environment
1. Check that your local version of Ruby matches the one in [.ruby-version](./.ruby-version). We recommend installing a tool like [rbenv](https://github.com/rbenv/rbenv) so your system will always use the version defined in that file. Once installed, simply run `rbenv install` in the repo to match the version.
1. Return to the command line and run `rake init:oss` to configure your computer and WordPress app to be able to run and login to WordPress.com
1. Once completed, run `rake xcode` to open the project in Xcode.
If all went well you can now compile to your iOS device or simulator, and log into the WordPress app.
Note: You can only log in with the WordPress.com account that you used to create the WordPress application.
## Configuration Details
The steps above will help you configure the WordPress app to run and compile. But you may sometimes need to update or re-run specific parts of the initial setup (like updating the dependencies.) To see how to do that, please check out the steps below.
### Third party tools
We use a few tools to help with development. Running `rake dependencies` will configure or update them for you.
### Open Xcode
Launch the workspace by running the following from the command line:
`rake xcode`
This will ensure any dependencies are ready before launching Xcode.
You can also open the project by double clicking on `WordPress.xcworkspace` file, or launching Xcode and choose `File` > `Open` and browse to `WordPress.xcworkspace`.
### Setup Credentials
In order to login to WordPress.com with the app you need to create an account over at the [WordPress.com Developer Portal](https://developer.wordpress.com).
After you create an account you can create an application on the [WordPress.com applications manager](https://developer.wordpress.com/apps/).
When creating your application, you should select "Native client" for the application type.
The "**Website URL**", "**Redirect URLs**", and "**Javascript Origins**" fields are required but not used for the mobile apps. Just use `https://localhost`.
Your new application will have an associated client ID and a client secret key. These are used to authenticate the API calls made by your application.
Next, run the command `rake credentials:setup` you will be prompted for your Client ID and your Client Secret. Once added you will be able to log into the WordPress app
**Remember the only WordPress.com account you will be able to login in with is the one used to create your client ID and client secret.**
Read more about [OAuth2](https://developer.wordpress.com/docs/oauth2/) and the [WordPress.com REST endpoint](https://developer.wordpress.com/docs/api/).
## Contributing
Read our [Contributing Guide](CONTRIBUTING.md) 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.
## Getting in Touch ##
If you have questions about getting setup or just want to say hi, join the [WordPress Slack](https://chat.wordpress.org) and drop a message on the `#mobile` channel.
## Resources
- The [docs](docs/) contain information about our development practices.
- [WordPress Mobile Blog](http://make.wordpress.org/mobile)
- [WordPress Mobile Handbook](http://make.wordpress.org/mobile/handbook/)
## License
WordPress for iOS is an Open Source project covered by the [GNU General Public License version 2](LICENSE).