Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samtgarson/nuxt-env
Inject env vars for your Nuxt app at runtime
https://github.com/samtgarson/nuxt-env
environment-variables nuxt nuxt-module nuxt-modules ssr vue
Last synced: 5 days ago
JSON representation
Inject env vars for your Nuxt app at runtime
- Host: GitHub
- URL: https://github.com/samtgarson/nuxt-env
- Owner: samtgarson
- Created: 2018-01-07T17:34:35.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T22:22:19.000Z (almost 2 years ago)
- Last Synced: 2024-10-31T16:46:56.492Z (11 days ago)
- Topics: environment-variables, nuxt, nuxt-module, nuxt-modules, ssr, vue
- Language: JavaScript
- Size: 1.97 MB
- Stars: 170
- Watchers: 5
- Forks: 15
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**nuxt-env** inject env vars for your Nuxt app at runtime
[](https://circleci.com/gh/samtgarson/nuxt-env)
---
### 🚨🛑 WARNING 🛑🚨
[Runtime Config](https://nuxtjs.org/docs/2.x/directory-structure/nuxt-config#runtimeconfig) has been released in Nuxt.js and solves the problem this package was solving, so this package has been is deprecated and will not be receiving any further updates _(There is some discussion in [this issue](https://github.com/nuxt/nuxt.js/issues/5100) in the Nuxt.js repo)_.
---
## Why
Nuxt currently provides a very [handy way of injecting environment variables](https://nuxtjs.org/api/configuration-env) which uses webpack substitution to inject your env vars at build time. This works most of the time, but if your build process is environment-agnostic (e.g. if you build a Docker image on CI and use the same image for staging and production), you end up with a result which has the environment baked into it (meaning that in our example, the docker image would be coupled to the environment it was built in).
This module allows you to read environment variables server side—at runtime—and inject them into your app, meaning your Nuxt bundle is decoupled from your environment variables.
⚠️ **WARNING**: As with the `config.env` option in Nuxt config, environment variables used in `nuxt-env` are exposed client side, so if you store secrets use the `secret` config option. Read more below. ⚠️
## Usage
`nuxt-env` injects your environment variables into your Nuxt app using `this.$env`.
_**N.B.** If currently use Nuxt's `config.env` option, fear not—`nuxt-env` includes those env vars in the `$env` object._
### Get Setup
1. Install the dependency:
```bash
yarn add nuxt-env
```
2. Add to your `nuxt.config.js` and configure:
```js
// nuxt.config.js
// Tell nuxt-env which env vars you want to inject
modules: [
'other-nuxt-module',
['nuxt-env', {
keys: [
'TEST_ENV_VAR', // Basic usage—equivalent of { key: 'TEST_ENV_VAR' }
{ key: 'OTHER_ENV_VAR', default: 'defaultValue' } // Specify a default value
{ key: 'THIRD_ENV_VAR', secret: true } // Only inject the var server side
{ key: 'ANOTHER_ENV_VAR', name: 'MY_ENV_VAR' } // Rename the variable
]
}]
]
```
#### Options
Env vars can be injected in a basic way, just by specifying a string in the `keys` option.
When the provided var is an object, it can have the following attributes:
##### `key`
> required
The name of the environment variable by which it can be accessed in `process.env`
##### `default`
A default value for the env var in case it's not present in `process.env`.
##### `secret`
> default: `false`
When true, this key will only be present server side.
##### `name`
Change the name of the env var that gets injected. e.g.: `{ key: 'API_URL', name: 'API_ENDPOINT' }` will read `process.env.API_URL` and add it as `$env.API_ENDPOINT`
### Use in your application
- Use `this.$env` in your components:
```js
// any-component.vue
export default {
computed: {
testValue () { return this.$env.TEST_VALUE }
}
}
```
- and in your Nuxt context
```js
// any-component.vue
export default {
asyncData ({ app }) {
console.log(app.$env.TEST_VALUE)
}
}
```
- and in your store:
```js
// store/index.js
export const mutations = {
storeEnv (commit) {
const val = this.$env.TEST_VALUE
commit('testValue', val)
}
}
```
## Develop
```bash
# First fork the repo
git clone [email protected]:your-username/nuxt-env.git
cd nuxt-env
npm i
npm run test
# To use while developing other apps:
npm link
cd ../my-other-app
npm link "nuxt-env"
```
### Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/samtgarson/nuxt-env. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
### Thanks
- Many thanks to [Evan You](https://github.com/yyx990803) and the [VueJS](https://github.com/vuejs) team for sustaining such a vibrant and supportive community around Vue JS
- Many thanks also [Alex Chopin](https://github.com/alexchopin), [SĂ©bastien Chopin](https://github.com/Atinux), [Pooya Parsa](https://github.com/pi0) and the other [Nuxt](https://github.com/nuxt) contributors for creating this awesome library
### License
The module is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).