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 social.plus 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

Choose your approach based on your timeline and customization needs:

🚀 Quick MVP

Timeline: 1-3 days
  • Package installation
  • Default styling
  • Basic authentication
  • Standard components
Perfect for demos and MVPs

🎨 Branded App

Timeline: 1-2 weeks
  • Package with themes
  • Custom brand colors
  • Component configuration
  • Platform testing
Great for production apps

🔧 Full Custom

Timeline: 2-4 weeks
  • GitHub source forking
  • Code modifications
  • Advanced integrations
  • Complete control
Maximum flexibility

​
Platform Support

UIKit supports all major development platforms with consistent APIs and components:

iOS

Native iOS Development
  • SwiftPM or CocoaPods
  • GitHub source available
  • iOS 16.0+
  • Swift 6.0+

Android

Native Android Development
  • Gradle package manager
  • GitHub source available
  • API Level 21+
  • Kotlin support

Web (React)

Modern Web Development
  • NPM package manager
  • GitHub source available
  • React 18+
  • Responsive design

Flutter

Cross-Platform Mobile
  • GitHub source only
  • Flutter 3.0+
  • Single codebase

React Native

Cross-Platform Development
  • GitHub source only
  • iOS 13.0+ / Android 21+
  • Full customization

​
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

​
Development Approaches

​
🚀 Rapid Prototyping (1-3 days)

Best for: MVPs, proof of concepts, demos 
1. Package installation (iOS/Android/Web/Flutter)
2. Basic authentication setup
3. Drop in pre-built components
4. Use default styling
5. Ship and iterate

​
🎨 Brand-Focused Development (1-2 weeks)

Best for: Branded apps, custom experiences 
1. Package installation with custom themes
2. Configure brand colors and styling
3. Customize component behavior
4. Test across platforms
5. Launch with brand consistency

​
🔧 Full Customization (2-4 weeks)

Best for: Unique experiences, complex requirements 
1. Fork GitHub repositories
2. Modify source code as needed
3. Implement custom business logic
4. Advanced styling and theming
5. Comprehensive testing and deployment

​
Prerequisites Checklist

Before starting, ensure you have:
Development Environment:
  • Platform-specific IDE (Xcode, Android Studio, VS Code)
  • Git for version control
  • Node.js (for React/React Native projects)
social.plus Account:
  • social.plus Console access
  • API key and region information
  • Application configured in console

​
Support & Resources

Documentation

Comprehensive component documentation with examples

Troubleshooting

Common issues and solutions for all platforms

Community

Connect with other developers and get help

Support

Direct support for technical questions

​
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 Build?

Add First ComponentAdd your first social component and see UIKit in action.
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!