amityco / amity-social-cloud-uikit-ios-opensource

Amity Social Cloud offers Chat and Social SDKs to streamline app development. Dive into our UI Kits and sample apps in our repositories to spark your creativity. To learn more, visit amity.co.

‼️ IMPORTANT ‼️

We have stopped active development in this repository and migrated to a New Repository. Please refer to our documentation for more details.

---

Amity Social Cloud SDKs

Boost app engagement and grow your user base with plug-and-play social features. Amity modules are ready to use — the only things left to do are integration and frontend.

Learn more about Amity here: amity.co→

AmityUIKit OpenSource

Our AmityUIKit include user interfaces to enable fast integration of standard Amity Chat and Amity Social features into new or existing applications.

Overview Architecture

MVVM is cleanly separates presentation layer from the other layers. Divorcing one from the other improves its maintainability and testability. It also makes the application evolution easier in the future, thereby reducing the risk of technological obsolescence.

Eliminates the need for application redesign user interfaces become outdated, or even add more complexity in the specific layer. For example, adding local data source to the application could be impacts to the other layers.

Please note that every view model in this project will be named as screen view model, e.g. AmityFeedScreenViewModel and AmityRecentChatScreenViewModel.

Installation

For latest UIKit releases > 2.35.0

AmityUIKit links with other dependencies such as AmitySDK, Realm, RealmSwift etc through SharedFrameworks which is a Swift Package.When you clone the project for the first time, all of this should be already setup for you.

To run sample app:

• Simply build AmityUIKit target & then build SampleApp target and you would be able to run the sample project.

If you encounter any issues, you can

• Reset Sample App project package cache.
• Make sure SharedFrameworks and AmityUIKit.framework is linked in Sample App.

If you want to integrate this open sourced codebase to your existing project, please follow the installation steps provided in our documentation. Installation Steps

For older UIKit releases < 2.35.0:

As our older version of UIKit depends upon git lfs, please run the following command before building framework or running sample app.

git lfs fetch

Then, run the following command.

git lfs pull

Building framework

AmityUIKit supports building xcframework which can be used on any Xcode version. Please follow this instruction for building.

1. In terminal, go to project directory
2. Run "./scripts/release-uikit.sh"
3. After building process is done, there will be amity-uikit.zip file

amity-uikit.zip contains AmityChat.xcframework, Realm.xcframework and AmityUIKit.xcframework.

Documentation

View the documentation for AmityUIKit.

Changelog

See the changelog to be aware of latest improvements and fixes.

Contribution guidelines

Please refer to the guidelines.

Resources

Developer Portal
Learn about building, deploying, and managing Amity Social Cloud.
Portal→

Documentation
Everything you need to integrate Amity Social Cloud.
Docs→

Developer Kits
Explore Amity Social Cloud UI Kits and Template Apps.
Developer Kits→

Community
Join the community of Amity Social Cloud developers.
Community→

FAQ
Get the answers to the most asked questions.
FAQ→

Amity Chat SDK

Amity Chat SDK is an easy-to-integrate solution that enables high-performing chat services on your app. From one-on-one to large-scale group messaging, power them with Amity Chat SDK, built with messaging service APIs to ignite connections and open discussions.

Learn more about Amity Chat on our website→ or view the Amity Chat Docs→

Amity Social SDK

Get in-app communities up and running using Amity Social SDK. Enable plug-and-play social features using supercharged social APIs and see preference-based groups thrive within your platform.

Learn more about Amity Social on our website→ or view the Amity Social Docs→

Amity Video SDK

The Amity Video SDK, powered by video APIs, elevates your application's user experience by adding interactive features such as in-app Stories and Live Streaming. Engage your users with captivating, memorable virtual events to participate in along with other viewers from around the world.

Learn more about Amity Video on our website→ or view the Amity Video Docs→

About Amity

The future is social — and we at Amity are on a mission to make social experiences more accessible than ever. Amity Social Cloud allows companies to easily integrate plug-and-play social features into their apps and digital channels to drive engagement, build communities, and grow revenue.

🟢 We're hiring! View all open positions→

License

Public Framework. Copyright © 2022 Amity.

amity-social-cloud-uikit-ios-opensource's Issues

Remove huge Git LFS files

Please consider purging the huge files in Git LFS amount as they amount to a whooping 14.4GB of total disk space:

93127200   39774434 2020-12-07 UpstraUIKit/Shared/Realm.framework/Realm
    42971740   10836559 2020-12-07 UpstraUIKit/Shared/EkoChat.framework/EkoChat
     1129752     328028 2020-12-07 UpstraUIKit/Shared/EkoChat.framework/Modules/EkoChat.swiftmodule/x86_64.swiftmodule
     1129752     328028 2020-12-07 UpstraUIKit/Shared/EkoChat.framework/Modules/EkoChat.swiftmodule/x86_64-apple-ios-simulator.swiftmodule
      556932     269079 2022-06-10 UpstraUIKit/UpstraUIKit/Utilities/Fonts/NotoSans-SemiBold.ttf
      555264     268941 2022-06-10 UpstraUIKit/UpstraUIKit/Utilities/Fonts/NotoSans-Medium.ttf
      554712     267985 2022-06-10 UpstraUIKit/UpstraUIKit/Utilities/Fonts/NotoSans-Light.ttf
      556216     264402 2022-06-10 UpstraUIKit/UpstraUIKit/Utilities/Fonts/NotoSans-Regular.ttf
 

Consider adding @objc() and prefix to all public and open class to avoid naming conflict

As an example in here

@objc(UpstraBottomSheetViewController)
open class BottomSheetViewController: UIViewController {
...
}

Post expand issue

When I try to expand a post by clicking on the "read more" button, other posts do not appear and the post itself does not expand. Instead, only white space is shown.

UIKIT Q&A and SLA detail

If there are some question regarding to source code or UIKIT implementation in this Repository , please feel free to add create the issue and add the label question and 3 possible priority tag base on the rule below

Criteria of priority
High : this question is blocking my implementation and can not find any other way around
Medium : this question is relate to how I can customise some specific case on the UIKIT side , but not the blocker of other implementation

SLA
for each priority we will respond within the time frame as following
High : 2 Day
Medium : 5 day