|
1 | | -LaunchDarkly Client-Side SDK for React Native |
2 | | -=========================== |
| 1 | +# LaunchDarkly Client-Side SDK for React Native |
3 | 2 |
|
4 | 3 | [](https://www.npmjs.com/package/launchdarkly-react-native-client-sdk) |
5 | 4 | [](https://circleci.com/gh/launchdarkly/react-native-client-sdk) |
6 | 5 | [](https://launchdarkly.github.io/react-native-client-sdk) |
7 | 6 |
|
8 | | -LaunchDarkly overview |
9 | | -------------------------- |
| 7 | +## LaunchDarkly overview |
| 8 | + |
10 | 9 | [LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves over 100 billion feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/home/getting-started) using LaunchDarkly today! |
11 | 10 |
|
12 | 11 | [](https://twitter.com/intent/follow?screen_name=launchdarkly) |
13 | 12 |
|
14 | | -Supported versions |
15 | | -------------------------- |
| 13 | +## Supported versions |
16 | 14 |
|
17 | 15 | This SDK is currently compatible with React Native versions `>=0.64 <0.71`, the minimum iOS deployment target is `10.0`, and the minimum Android SDK version is `21`. Builds are tested with XCode 12.5+. Please look at the CircleCI test build to see which combination of React Native and XCode works together. |
18 | 16 |
|
19 | 17 | For React Native `0.63.x` support, use the latest [`5.1.x` release](https://github.com/launchdarkly/react-native-client-sdk/releases/tag/5.1.1). |
20 | 18 |
|
21 | | -Getting started |
22 | | ---------------- |
| 19 | +## Getting started |
23 | 20 |
|
24 | 21 | Refer to the [SDK documentation](https://docs.launchdarkly.com/sdk/client-side/react/react-native#getting-started) for instructions on getting started with using the SDK. |
25 | 22 |
|
26 | | -Learn more |
27 | | ------------ |
| 23 | +## Learn more |
28 | 24 |
|
29 | 25 | Check out 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/react/react-native). |
30 | 26 |
|
31 | | -Testing |
32 | | -------- |
| 27 | +## Testing |
33 | 28 |
|
34 | 29 | 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. |
35 | 30 |
|
36 | | -Contributing |
37 | | ------------- |
| 31 | +## Contributing |
38 | 32 |
|
39 | 33 | 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. |
40 | 34 |
|
41 | | -About LaunchDarkly |
42 | | ------------ |
43 | | - |
44 | | -* 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: |
45 | | - * 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. |
46 | | - * 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?). |
47 | | - * 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. |
48 | | - * 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. |
49 | | -* 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. |
50 | | -* Explore LaunchDarkly |
51 | | - * [launchdarkly.com](https://www.launchdarkly.com/ "LaunchDarkly Main Website") for more information |
52 | | - * [docs.launchdarkly.com](https://docs.launchdarkly.com/ "LaunchDarkly Documentation") for our documentation and SDK reference guides |
53 | | - * [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ "LaunchDarkly API Documentation") for our API documentation |
54 | | - * [blog.launchdarkly.com](https://blog.launchdarkly.com/ "LaunchDarkly Blog Documentation") for the latest product updates |
55 | | - |
56 | | -Developing this SDK |
57 | | ------------ |
58 | | - |
59 | | -* Run `npx react-native doctor` in both the root and ManualTestApp directories and make sure everything is green |
60 | | - * If watchman fails, you can try installing it manually `brew reinstall watchman` |
61 | | -* Make sure you have [modd](https://github.com/cortesi/modd#install) installed so native code changes are hot reloaded |
62 | | -* Run `modd` |
| 35 | +## About LaunchDarkly |
| 36 | + |
| 37 | +- 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: |
| 38 | + - 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. |
| 39 | + - 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?). |
| 40 | + - 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. |
| 41 | + - 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. |
| 42 | +- 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. |
| 43 | +- Explore LaunchDarkly |
| 44 | + - [launchdarkly.com](https://www.launchdarkly.com/ 'LaunchDarkly Main Website') for more information |
| 45 | + - [docs.launchdarkly.com](https://docs.launchdarkly.com/ 'LaunchDarkly Documentation') for our documentation and SDK reference guides |
| 46 | + - [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation |
| 47 | + - [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates |
| 48 | + |
| 49 | +## Developing this SDK |
| 50 | + |
| 51 | +- Run `npx react-native doctor` in both the root and ManualTestApp directories and make sure everything is green |
| 52 | + - If watchman fails, you can try installing it manually `brew reinstall watchman` |
| 53 | +- Make sure you have [modd](https://github.com/cortesi/modd#install) installed so native code changes are hot reloaded |
| 54 | + |
| 55 | +* For ios run `modd -f modd-ios.conf` |
| 56 | +* For android run `modd -f modd-android.conf` |
0 commit comments