Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/launchdarkly/ios-client-sdk
LaunchDarkly Client-side SDK for iOS (Swift and Obj-C)
https://github.com/launchdarkly/ios-client-sdk
feature-flags feature-toggles ios launchdarkly launchdarkly-sdk managed-by-terraform objective-c sdk swift
Last synced: about 2 months ago
JSON representation
LaunchDarkly Client-side SDK for iOS (Swift and Obj-C)
- Host: GitHub
- URL: https://github.com/launchdarkly/ios-client-sdk
- Owner: launchdarkly
- License: other
- Created: 2015-10-28T00:32:16.000Z (almost 9 years ago)
- Default Branch: v9
- Last Pushed: 2024-05-17T15:16:20.000Z (4 months ago)
- Last Synced: 2024-05-18T03:11:29.239Z (4 months ago)
- Topics: feature-flags, feature-toggles, ios, launchdarkly, launchdarkly-sdk, managed-by-terraform, objective-c, sdk, swift
- Language: Swift
- Homepage: https://docs.launchdarkly.com/sdk/client-side/ios
- Size: 110 MB
- Stars: 67
- Watchers: 52
- Forks: 83
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
LaunchDarkly SDK for iOS
========================
[](https://github.com/launchdarkly/ios-client-sdk/actions/workflows/ci.yml)
[](https://swift.org/package-manager/)
[](https://cocoapods.org/pods/LaunchDarkly)
[](https://github.com/Carthage/Carthage)
[](https://docs.launchdarkly.com/sdk/client-side/ios)
LaunchDarkly overview
-------------------------
[LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves trillions of feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/home/getting-started) using LaunchDarkly today!
[](https://twitter.com/intent/follow?screen_name=launchdarkly)
Supported iOS and Xcode versions
-------------------------
This version of the LaunchDarkly SDK has been tested across iOS, macOS, watchOS, and tvOS devices.
The LaunchDarkly iOS SDK requires the following minimum build tool versions:
| Tool | Version |
| ----- | ------- |
| Xcode | 12.5+ |
| Swift | 5.3+ |
And supports the following device platforms:
| Platform | Version |
| -------- | ------- |
| iOS | 12.0 |
| watchOS | 4.0 |
| tvOS | 12.0 |
| macOS | 10.13 |
Installation
-----------
LaunchDarkly supports multiple methods for installing the library in a project. Once installed, head over to the [SDK documentation](https://docs.launchdarkly.com/sdk/client-side/ios#getting-started) for complete instructions on getting started with using the SDK.
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a dependency manager integrated into the `swift` compiler and Xcode.
To integrate LaunchDarkly into an Xcode project, go to the project editor, and select `Swift Packages`. From here hit the `+` button and follow the prompts using `https://github.com/launchdarkly/ios-client-sdk.git` as the URL.
To include LaunchDarkly in a Swift package, simply add it to the dependencies section of your `Package.swift` file. And add the product "LaunchDarkly" as a dependency for your targets.
```swift
dependencies: [
.package(url: "https://github.com/launchdarkly/ios-client-sdk.git", .upToNextMajor(from: "9.10.0"))
]
```
### CocoaPods
To use the [CocoaPods](https://cocoapods.org) dependency manager to integrate LaunchDarkly into your Xcode project, specify it in your `Podfile`:
```ruby
use_frameworks!
target 'YourTargetName' do
pod 'LaunchDarkly', '~> 9.10'
end
```
### Carthage
To use the [Carthage](https://github.com/Carthage/Carthage) dependency manager to integrate LaunchDarkly into your Xcode project, specify it in your `Cartfile`:
To integrate LaunchDarkly into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
github "launchdarkly/ios-client-sdk" ~> 9.10
```
### Manual installation
If you prefer not to use the aforementioned dependency managers, it is possible to integrate the SDK manually.
1. On the root folder of the project retreive the SDK by either:
* Adding the SDK as a git submodule with `git submodule add https://github.com/launchdarkly/ios-client-sdk.git`.
* OR cloning the SDK with `git clone https://github.com/launchdarkly/ios-client-sdk.git`.
2. Open the new `ios-client-sdk` folder and drag `LaunchDarkly.xcodeproj` into the project navigator of your application's Xcode project. It should appear nested within your application's blue project icon.
3. Select your application project in the project navigator (blue icon) and select your application target under the "Targets" heading in the sidebar. If you have multiple targets, perform the following steps for each target.
4. Select the "General" tab, and if necessary expand the subsection "Frameworks, Libraries, and Embedded Content".
5. Click the "+" button in the expanded subsection. Under "LaunchDarkly" within the dialog you will see 4 frameworks, select `LaunchDarkly.framework` for iOS, or `LaunchDarkly_` for other platforms.
Learn more
-----------
Read our [documentation](https://docs.launchdarkly.com) for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the [complete reference guide for this SDK](https://docs.launchdarkly.com/sdk/client-side/ios).
Testing
-------
We run integration tests for all our SDKs using a centralized test harness. This approach gives us the ability to test for consistency across SDKs, as well as test networking behavior in a long-running application. These tests cover each method in the SDK, and verify that event sending, flag evaluation, stream reconnection, and other aspects of the SDK all behave correctly.
Privacy
-------
At WWDC23, Apple introduced the concept of Privacy Manifests. The privacy manifest included with the SDK describes our data usage with respect to the minimum case of data collection. If you utilize the SDK, you will have to update your own privacy manifest if you choose to collect more data in your implementation than the minimum for our SDK to function.
To learn more about Privacy Manifests, please refer to [Apple Developer Documention.](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_data_use_in_privacy_manifests)
Contributing
------------
We encourage pull requests and other contributions from the community. Check out our [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute to this SDK.
About LaunchDarkly
-----------
* LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
* Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
* Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
* Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
* Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
* LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read [our documentation](https://docs.launchdarkly.com/sdk) for a complete list.
* Explore LaunchDarkly
* [launchdarkly.com](https://www.launchdarkly.com/ "LaunchDarkly Main Website") for more information
* [docs.launchdarkly.com](https://docs.launchdarkly.com/ "LaunchDarkly Documentation") for our documentation and SDK reference guides
* [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ "LaunchDarkly API Documentation") for our API documentation
* [blog.launchdarkly.com](https://blog.launchdarkly.com/ "LaunchDarkly Blog Documentation") for the latest product updates