Skip to content

AmityCo/ASC-UIKit-iOS-OpenSource

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Amity Social Cloud SDKs

Amity logo



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.

Screen Shot 2564-11-22 at 08 29 57

Screen Shot 2564-11-22 at 08 30 03


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.



Amity Social Cloud SDKs

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.