README.md

Twidere X

Next generation of Twidere for iOS.

Requirements

• Xcode 13.0+
• Swift 5.5+
• iOS 15+

Quick Start

Before clone and install the dependency. You need apply for the Twitter developer and setup Twitter APIv2 App to use the OAuth API key. Make the app permissions to "Read, Write, and Direct Messages" and enable "3-legged OAuth". Copy and save your API key and API key secret.

All you need

• Twitter app API key and API key secret
• The latest Xcode from the App Store
• A .env file contains the keys. Check the .env template and create yours

git clone https://github.com/TwidereProject/TwidereX-iOS
cd TwidereX-iOS

gem install bundle
bundle install

# For contributor
bundle exec arkana -e ./env/.env.Homebrew -f Homebrew

# For App Store release
# bundle exec arkana -e <path-to-env/.env.AppStore> -f AppStore

bundle exec pod install
open TwidereX.xcworkspace  

After open the project in the Xcode. Choose TwidereX scheme and build and run the app by ⌘R.

Note:
The host_key_public is preserved by App Store release and not needs for the open-source build. And you may needs to change bundle identifier in the Xcode to avoid conflict.

Translation

The localization resource files locate in TwidereX-Localization repo. We are welcome translator use our Crowdin project contribute.

Acknowledgements

• Alamofire
• AlamofireImage
• AlamofireNetworkActivityIndicator
• Arkana
• cocoapods-keys
• CommonOSLog
• CryptoSwift
• DateToolSwift
• Floaty
• Kanna
• KeychainAccess
• Kingfisher
• LineChart
• PageBoy
• Popovers
• swift-nio
• SwiftGen
• SwiftMessages
• SwiftyJSON
• Tabman
• TOCropViewController
• twitter-text
• TwitterProfile
• webpush-fcm-relay
• ZIPFoundation

License

TwidereX-iOS is released under the GPLv3 license. See LICENSE for details.