Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
env-examples

Most configuration really isn't about the app -- it's about where the app runs, what keys it needs to communicate with third party API's, the db password and username, etc... They're just deployment details -- and there are lots of tools to help manage environment variables -- not the least handy being a simple .env file with all your settings. Simply source the appropriate env before you launch the app in the given env (you could make it part of a launch script, for instance).

env files look like this:

SOMEVAR="somevalue"
ANOTHERVAR="anothervalue"

To source it:

$ source dev.env  # or staging.env, or production.env, depending on where you're deploying to

Don't check these files into the repo... instead, check in something like dev.example.env, containing some sensible defaults, minus your app secrets, of course. Devs wishing to collaborate should copy the file to the real filename, set the values appropriately, and they're off to the races.

It's easy to add scripts via npm, so you can source the appropriate env file by running commands:

In your package.json:

scripts: {
  "start-dev": "source dev.env; node server.js"
  "start-prod": "source prod.env; node server.js"
}

Then start it up:

$ npm start-prod
@alizzen

This comment has been minimized.

Copy link

alizzen commented Apr 2, 2017

you my friend are a simple genius

@robophil

This comment has been minimized.

Copy link

robophil commented Apr 20, 2017

@alizzen, my thoughts exactly

@JohnnyBizzel

This comment has been minimized.

Copy link

JohnnyBizzel commented Apr 24, 2017

I get "source" not found. What is "source"?

@PiP-iT-Global

This comment has been minimized.

Copy link

PiP-iT-Global commented Feb 5, 2019

To use a custom script you need the 'run' flag:

npm run start-prod

@thibauds

This comment has been minimized.

Copy link

thibauds commented May 6, 2019

If you get sh: 1: source: not found this is because your shell does not support source, try using .:
replace source dev.env by . dev.env

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.