react-native-dotenv

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

Github stars Tracking Chart

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.

API_KEY=lorem
ANOTHER_CONFIG=foobar

Now you can import it in your .js file.

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

ApiClient.init(API_KEY, ANOTHER_CONFIG)

How does it work?

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

The example above will get compiled as below.


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

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.

Main metrics

Overview
Name With Ownerzetachang/react-native-dotenv
Primary LanguageJavaScript
Program languageJavaScript (Language Count: 1)
Platform
License:MIT License
所有者活动
Created At2016-09-05 17:20:11
Pushed At2020-05-27 18:01:02
Last Commit At2019-02-01 19:52:58
Release Count5
Last Release Namev0.2.0 (Posted on )
First Release Namev0.0.3 (Posted on )
用户参与
Stargazers Count0.9k
Watchers Count11
Fork Count68
Commits Count52
Has Issues Enabled
Issues Count60
Issue Open Count37
Pull Requests Count8
Pull Requests Open Count9
Pull Requests Close Count8
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private