Skip to content

anova-culinary/react-native-dotenv

 
 

Repository files navigation

react-native-dotenv

Let you import environment variables from a .env file in React Native, don't need any native code integration.

CircleCI npm version npm downloads

Install

$ npm install react-native-dotenv --save-dev

Add the react-native-dotenv preset to your .babelrc file at the project root.

{
  "presets": ["module:metro-react-native-babel-preset", "module:react-native-dotenv"]
}

If you haven't got .babelrc set up for React Native, remember to install metro-react-native-babel-preset first.

$ npm install metro-react-native-babel-preset --save-dev

Usage

Add your app configuration in an .env file. Prefix your values with $ to obtain from system env.

API_KEY=lorem
ANOTHER_CONFIG=foobar
ANOTHER_API_KEY=$API_KEY_FROM_SYSTEM_ENV

Now you can import it in your .js file.

import { API_KEY, ANOTHER_CONFIG, ANOTHER_API_KEY } from 'react-native-dotenv'

ApiClient.init(API_KEY, ANOTHER_CONFIG, ANOTHER_API_KEY)

How does it work?

As you can see, it's implemented as a babel plugin. All referenced imported members are replaced as the values or environment variables specified in the .env file

The example above will get compiled as below, assuming your system environment variable API_KEY_FROM_SYSTEM_ENV is this_value_is_from_system_env

ApiClient.init('lorem', 'foobar', 'this_value_is_from_system_env')

FAQ

Changes to .env file is not updated

Manually edit the file importing react-native-dotenv by either adding an empty line or whitespace will work.

Can I use different .env settings for production ?

Yes, simply create a separate .env.production file and the default release process of react-native will pickup the right config.

iOS

You can use the Release configuration to launch the Simulator. (Only supported in RN v0.39+)

react-native run-ios --configuration Release

Android

  1. Command⌘ + M to launch the developer menu in Android emulator.
  2. Tap DevSettings.
  3. Toggle JS Dev Mode.

Can I have more than production & development environment configs?

Sadly, it's not available so far. One of the workaround is generating .env file before triggering RN's bundle script automatically using either shell script or your own custom build pipeline.

Contact

David Chang @zetachang

LICENSE

MIT License, see LICENSE file for detail.

About

A Babel preset let you import application configs from .env file (zero runtime dependency)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%