docs(core): add env vars documentation

This commit is contained in:
Michael Lancaster 2020-03-23 12:09:39 +00:00 committed by Jo Hanna Pearce
parent 2d02777c9a
commit e08888ae55
3 changed files with 43 additions and 1 deletions

View File

@ -105,7 +105,7 @@ You can then go to `tmp/nx` (this is set up to use Nx CLI) or `tmp/angular` (thi
```bash
yarn create-playground
cd tmp/nx
cd tmp/nx/proj
nx g @nrwl/express:app backend
nx build backend
```

View File

@ -554,6 +554,11 @@
"name": "Imposing Constraints on the Dependency Graph",
"id": "monorepo-tags",
"file": "shared/monorepo-tags"
},
{
"name": "Using Environment Variables",
"id": "environment-variables",
"file": "react/guides/environment-variables"
}
]
}

View File

@ -0,0 +1,37 @@
# Environment Variables
Environment variables are global system variables accessible by all the processes running under the Operating System (OS). Environment variables are useful to store system-wide values such as the directories to search for executable programs (PATH), OS version, Network Information, and custom variables. These env variables are passed at build time and used at the runtime of an app.
## How to Use
It's important to note that NX will only include in the process default and NX prefixed env vars such as: `NODE_ENV` or `NX_CUSTOM_VAR`.
Defining environment variables can vary between OSes. Its also important to know that this is temporary for the life of the shell session.
**Unix systems**
In Unix systems, we need to pass the env vars before passing the (or other) commands \
Let's say we want to build with development mode, with env vars we can do that like so:
```bash
NODE_ENV=development nx build myapp
```
And if we want to add a custom env var for the command above, it would look like:
```bash
NODE_ENV=development NX_BUILD_NUMBER=123 nx build myapp
```
**Windows (cmd.exe)**
```bash
set "NODE_ENV=development" && nx build myapp
```
**Windows (Powershell)**
```bash
($env:NODE_ENV = "development") -and (nx build myapp)
```