iOS
Social Plus iOS UIKit Migration Guide
Last updated
Social Plus iOS UIKit Migration Guide
Last updated
This section is about installing managed uikit through dependency manager (SwiftPM). If you have already installed our Open Source UIKit, you can skip this section.
Go to Xcode and create a project for iOS.
Enter a project name
Select Swift as your language option
To integrate Social Plus UIKit into your project via SwiftPM, please follow the instruction below.
Enter the repository URL to search the package, and choose to install AmityUIKit.
Please specify the required version of the UIKit v4 beta using "Exact Version"Dependency Rule as shown in the image below.
For Example: `Exact Version` `4.0.0-beta23`
After finished installing SDK. You will be able to import AmityUIKit.
With open-source, developers have more flexibility and greater customization options, allowing you to have complete control over the visual style. Open sourcing allows for more transparency and visibility and enables contributions from a greater developer community in terms of good design, implementation, code improvement, and fixes, translating into a better product and typical development.
If you've never used UI Kit, you may skip this step and proceed to the next step.
If you're integrating the UI Kit with an existing project, you'll need to remove and unlink the managed UIKit from your project before proceeding with the integration.
There are several ways for you to migrate the open-source iOS UI Kit into your projects, depending on your workflow. One way that we recommend is via Git Submodule. This instruction assumes that the app project is already set up with a Git repository.
Add the git submodule of Social Plus UIKit open source into your git repository.
To simplify forking & contributing to the open-source UIKit, we are moving away from using git-lfs in our git repository. We are migrating all development of Open Source UIKit to a new repository https://github.com/AmityCo/ASC-UIKit-iOS-OpenSource starting release v3.12.0. The previous open source UIKit Repository https://github.com/AmityCo/Amity-Social-Cloud-UIKit-iOS-OpenSource is now deprecated. The new repository will not contain any history before the release of v3.12.0.
For new users:
If you are just starting to use Open Source UIKit or already using the latest version of Open Source UIKit (i.e. v3.12.0) from the old Repository, We suggest you start pulling changes from the new repository instead.
In this case,
If you have forked the old open-source UIKit repository, we suggest you fork the new repository and use that instead.
For Old Users:
If you are using an older version (< 3.12.0) of open-source UIKit, we suggest you upgrade to the latest version of UIKit as soon as possible. Once you are caught up to version 3.12.0, please migrate to use the new repository instead.
Create an Xcode Workspace, and then add both MyApp.xcodeproj and AmityUIKit.xcodeproj together under the same workspace.
3.AmityUIKit links with other dependencies such as AmitySDK, Realm etc through SharedFrameworks which is a Swift Package.
Step 1: Reset the Package Cache of your Application Target i.e YourApp.xcodeproj. [If you are installing AmityUIKit for the first time, you can skip this step]
Select App Target In Xcode Project -> Select File Menu for Xcode-> Packages -> Reset Package Cache
Step 2: Link SharedFrameworks & AmityUIKit.framework to YourApp.xcodeproj target as shown below.
4. On MyApp.xcodeproj, let’s try importing Social Plus UIKit / Social Plus SDK and call some APIs. You should be able to compile and run the app.
You can modify the iOS open-source UI Kit to customize behaviors to fit your needs. To modify the code, simply copy and paste it into your local machine.
We recommend that you first fork the repository before starting any customization work so that it will be easier to merge the code with the next version update that we provide from the main repository.
References on forking: https://docs.github.com/en/get-started/quickstart/fork-a-repo
To update to the latest version of the UI Kit, you can pull the latest commit of the git submodule.
