mastodon-ios/README.md

Mastodon

Requirements

• Xcode 12.5+
• Swift 5.3+
• iOS 14.0+

Setup

We need the latest version of Xcode from App Store. And use Cocoapods for dependency management.

CocoaPods

For the Intel Mac

sudo gem install cocoapods
sudo gem install cocoapods-keys
pod install

For the M1 Mac

sudo gem install cocoapods
sudo gem install cocoapods-keys

# pod install may not works on M1 Mac. Fix by install ffi
# ref: https://github.com/CocoaPods/CocoaPods/issues/10220
sudo arch -x86_64 gem install ffi

arch -x86_64 pod install

Start

1. Open Mastodon.xcworkspace
2. Wait the Swift Package Dependencies resolved.
3. Check the signing settings make sure choose a team. More info…
4. Select Mastodon scheme and run it.

Contributors

The app require the App Group capability. To make sure it works for your developer membership. Please check AppName.swift file and set another unique groupID and update App Group settings.

The app is compatible with toot-relay APNs. You can set your push notification endpoint via cocoapod-keys.

Acknowledgements

• AlamofireImage
• AlamofireNetworkActivityIndicator
• Alamofire
• CommonOSLog
• CryptoSwift
• DateToolSwift
• DiffableDataSources
• DifferenceKit
• FLAnimatedImage
• FLEX
• FPSIndicator
• Fuzi
• Kanna
• KeychainAccess
• Kingfisher
• MetaTextKit
• Nuke-FLAnimatedImage-Plugin
• Nuke
• Pageboy
• PanModal
• SDWebImage
• swift-collections
• swift-nio
• SwiftGen
• SwiftUI-Introspect
• SwiftyJSON
• Tabman
• TwidereX-iOS
• ThirdPartyMailer
• TOCropViewController
• TwitterProfile
• UITextView-Placeholder

License

This project is released under the GPL-3 License. It is also dual-licensed to Apple for the purposes of publishing the app on the App Store. For this reason, any contributors are required to sign a Contributor License Agreement.