Amplify for iOS
Our default implementation works with Amazon Web Services (AWS), but AWS Amplify is designed to be open and pluggable for any custom backend or service.
- API Documentation https://docs.amplify.aws/start/q/integration/ios
- Analytics - for logging metrics and understanding your users.
- API (GraphQL) - for adding a GraphQL endpoint to your app.
- API (REST) - for adding a REST endpoint to your app.
- Authentication - for managing your users.
- DataStore - for making it easier to program for a distributed data store for offline and online scenarios.
- Predictions - to detect text, images, and more!
- Storage - store complex objects like pictures and videos to the cloud.
All services and features not listed above are supported via the iOS SDK or if supported by a category can be accessed via the Escape Hatch like below:`
let rekognitionService = Amplify.Predictions.getEscapeHatch(key: .rekognition) as! AWSRekognition let request = rekognitionService.AWSRekognitionCreateCollectionRequest() rekognitionService.createCollection(request)
Amplify supports iOS 11 and above and iOS 13 for certain categories such as Predictions. There are currently no plans to support Amplify on WatchOS, tvOS, or MacOS.
This library is licensed under the Apache 2.0 License.
Amplify requires Xcode 11.4 or higher to build.
Amplify for iOS is available through CocoaPods. If you have not installed CocoaPods, install CocoaPods by running the command:
$ gem install cocoapods $ pod setup
Depending on your system settings, you may have to use
$ sudo gem install cocoapods $ pod setup
In your project directory (the directory where your
*.xcodeprojfile is), type
pod initand open the Podfile that was created. Add the
Amplifypod and any plugins you would like to use. Below is an example of what a podfile might look like if you were going to use the Predictions plugin.
source 'https://github.com/CocoaPods/Specs.git' platform :ios, '13.0' use_frameworks! target :'YourTarget' do pod 'Amplify' pod 'AmplifyPlugins/AWSCognitoAuthPlugin' pod 'AWSPredictionsPlugin' pod 'CoreMLPredictionsPlugin' end
Then run the following command:
$ pod install
*.xcworkspacewith Xcode and start using Amplify.
Note: Do NOT use
*.xcodeproj. If you open up a project file instead of a workspace, you will receive an error.
Swift Package Manager (SPM)
Support for SPM coming soon. Follow #90 for updates.
You can manually install the library by cloning this repo and creating a Podfile that references your local clone of it like below:
pod 'Amplify', :path => '~/amplify-ios' pod 'AWSPluginsCore', :path => '~/amplify-ios' pod 'CoreMLPredictionsPlugin', :path => '~/amplify-ios' pod 'AWSPredictionsPlugin', :path => '~/amplify-ios' pod 'AmplifyPlugins/AWSAPIPlugin', :path => '~/amplify-ios'
Then, install the dependencies:
Open your project using ./YOUR-PROJECT-NAME.xcworkspace file. Remember to always use ./YOUR-PROJECT-NAME.xcworkspace to open your Xcode project from now on.
Reporting Bugs/Feature Requests
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
- Expected behavior and observed behavior
- A reproducible test case or series of steps
- The version of our code being used
- Any modifications you've made relevant to the bug
- Anything custom about your environment or deployment
Open Source Contributions
We welcome any and all contributions from the community! Make sure you read through our contribution guide here before submitting any PR's. Thanks! <3