react-native-ultimate-config

react-native-ultimate-config

The ultimate config you ever need for your react-native app

TL;DR usage

1. install: yarn add react-native-ultimate-config
2. one time setup for native projects
3. initialize env yarn rnuc .env
4. build! react-native run-{ios,android}

Table of contents

1. Features
2. Mission
3. Quickstart Guide
4. API
5. TypeScript Support
6. Competitors

Features

1. Access from javascript
2. Access from native code: java and objective-c
3. Access in build tools: xcode and gradle
4. Unit tested
5. e2e tested
6. Provides typescript typings

Mission

React-Native brings together 3 platforms: ios, android, javascript each of which have different conventions and approaches how to manage environment settings.

react-native-ultimate-config exposes configuration from env files to all levels of the projects:

1. javascript
2. native code
   • java
   • objective-c
3. native build configuration
   • ios
     • build settings
     • infoplist
   • android
     • build config
     • string resources
     • project.ext

|-------------------------------------------------------|
|                                                       |
|                     javascript                        |
|                                                       |
|-------------------------------------------------------|
|                          |                            |
|       objective-c        |           java             |
|                          |                            |
|-------------------------------------------------------|
|                          |                            |
|      build settings      |     AndroidManifest.xml    |
|         infoplist        |        build.gradle        |
|                          |                            |
|-------------------------------------------------------|

react-native-ultimate-config offers a way to configure your projects on all levels and keep configuration data separate from code or project files: api urls, app names, feature flags. Anything you would typically put into environment can now be loaded from a separate file.

After trivial one-time setup of native projects exposing environment to the app happens with a single command.

TypeScript Support

index.d.ts is generated dynamically according to variables defined in envfile

Competitors

project	comparison
react-native-config	Allows configuring native and javascript but project seems to be abandoned.
react-native-dotenv	Javascript only. Does not allow configure native counterpart of the app.