Welcome to social.plus UIKit! This guide will get you from zero to a working social app in under 15 minutes. Follow these steps to add complete social features to your app.

​
Quick Start Guide

1

Choose Your Platform

Select the UIKit that matches your development environment and install:
Installation Options: Choose package installation for quick setup or GitHub forking for complete customization. React Native and Flutter are only available through GitHub forking.
2

Get Your API Key

  1. Visit the Admin Console
  2. Navigate to Applications → Your App → Settings
  3. Copy your API key and note your region (US, EU, or SG)
Keep your API key secure. For production apps, implement proper server-side authentication.
3

Initialize UIKit & Authenticate a user

Install UIKit and set up with your API credentials (for more details, see the authentication guide):
// Add to your AppDelegate or SceneDelegate
import AmityUIKit

AmityUIKitManager.setup(
    apiKey: "your-api-key",
    region: .US  // .US, .EU, or .SG
)

// Register user when the user accesses the feature
AmityUIKitManager.registerDevice(
  withUserId: "USER_ID", 
  displayName: "Ali Connors", 
  authToken: "AUTH_TOKEN"
)
4

Add Your First Component

Start with a social feed or any component that fits your app:
let socialHomePage = AmitySocialHomePage()
let navigationViewController = AmitySwiftUIHostingNavigationController(rootView: socialHomePage)

​
Development Paths

UIKit offers four progressive customization levels. Start at the lowest level that solves today’s need—move up only when you hit a limitation. Each level layers on the previous one; no throwaway work.

1. Dynamic UI

Remote + conditional configuration & layout: role‑based visibility, experiments, feature flags, runtime theme adjustments.

Use when you need server‑driven variations without redeploys.

2. Component Styling

Targeted page / component / element overrides: icons, button styles, layout spacing, per‑feature navigation behavior.

Use when a few components need deeper tweaks beyond tokens.

3. Fork & Extend

Full source fork for new UX paradigms, custom data flows, or deep platform integrations.

Use only when earlier layers cannot achieve your required behavior.
Decision shortcut:
You can safely prototype at Level 1 and graduate upward without rewriting work—higher levels augment, not replace, earlier configuration.

​
Installation Methods

UIKit offers two installation approaches to match your development needs:

Package Installation

Quick Setup (Recommended)✅ Platforms: iOS, Android, Web
❌ Not available: Flutter, React Native
  • Managed dependencies and updates
  • Minimal configuration required
  • Perfect for most use cases
  • Easy version management

GitHub Fork

Complete Customization✅ All Platforms: iOS, Android,Web, Flutter, React Native
  • Full source code access
  • Custom modifications possible
  • Advanced integrations
  • Maximum flexibility
React Native Special Case: React Native UIKit is only available through GitHub forking, giving you complete control over the implementation.

​
Use Case Examples

Choose your starting point based on what you want to build:
Perfect for: Instagram-like apps, social networks, content sharing platformsStart with these components:
  1. Social Feed - Display user posts and content
  2. User Profiles - User information and social connections
  3. Post Creation - Rich content creation tools
  4. Comments & Reactions - User engagement features
Timeline: 1-2 weeks for MVP

​
Ready to Start?

Choose your next step based on your current status:

New to UIKit?

Start with InstallationSet up UIKit for your platform and get your development environment ready.

Already Installed?

Configure AuthenticationSet up your API credentials and user authentication system.

Ready to Customize?

Customize UIKitCustomize UIkit to match your app’s branding and user experience.
Quick Win: If you just want to see UIKit in action, follow our 5-minute setup guide and add a social feed to your app!