# spore-node

> Load Spore Environment variables in a Node.js application

Latest version **0.10.0** (published 2015-09-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install spore-node
pnpm add spore-node
yarn add spore-node
bun add spore-node
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.10.0 |
| Published | 2015-09-09 |
| First published | 2015-06-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Trey Griffith |
| Maintainers | treygriffith |

## Links

- npm: https://www.npmjs.com/package/spore-node
- Repository: https://github.com/spore-sh/spore-node
- Issues: https://github.com/spore-sh/spore-node/issues
- npm.io page: https://npm.io/package/spore-node

## Dependencies (12)

- [slug](https://npm.io/package/slug.md) ^0.9.1
- [async](https://npm.io/package/async.md) ^0.9.0
- [debug](https://npm.io/package/debug.md) ^2.2.0
- [merge](https://npm.io/package/merge.md) ^1.2.0
- [deasync](https://npm.io/package/deasync.md) ^0.1.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^0.18.3
- [netrc-rw](https://npm.io/package/netrc-rw.md) 1.0.0
- [node-uuid](https://npm.io/package/node-uuid.md) ^1.4.3
- [spore-api](https://npm.io/package/spore-api.md) ^0.6.2
- [json-comment](https://npm.io/package/json-comment.md) 0.0.1
- [spore-errors](https://npm.io/package/spore-errors.md) 0.0.2
- [expand-home-dir](https://npm.io/package/expand-home-dir.md) 0.0.2

## Recent versions

- 0.10.0 (latest) — 2015-09-09
- 0.9.1 — 2015-06-03
- 0.9.0 — 2015-06-03

## README

spore-node
==========

This is the module for interacting with [Spore](https://spore.sh) for Node.js.
See the [Spore Website](https://spore.sh) for full documentation and information.

Installation
------------

```
$ npm install --save spore-node
```

or:

```
$ npm install --save git://git@github.com:spore-sh/spore-node.git
```

Usage
-----

### Synchronous

To load enviornment variables, put the following at the top of
your main javascript file:

```
require('spore-node').loadEnvSync();
```

Environment variables will then be available on the familiar `process.env` object.

With no arguments, `loadEnvSync` will load the default environment (on your local machine,
this is likely `development`, when using a `SPORE_DEPLOYMENT` it will default to that
deployment's environment). To load a specific environment, pass it as an argument to `loadEnvSync`:

```
require('spore-node').loadEnvSync('staging');
```

By default, environment variables set in the environment take precendence over those set in Spore.
To have Spore override the environment, use a second argument with the value `true`:

```
require('spore-node').loadEnvSync('staging', true);
```

### Asynchronous

You can also load the environment asynchronously, with a callback that gets called when it's done loading:

```
require('spore-node').loadEnv(function () {
  // variables will be loaded now
});
```

The `loadEnv` method has the same signature as the synchronous version for overriding the environment and
loading a particular environment.


Configuration
-------------

Spore has some configuration stored locally on your machine in a file called `config.json`, by default in `~/.spore`.
You can adjust the location of Spore's home directory by setting the `SPORE_HOME` environment variable.

The default values for `config.json` are [located here](lib/spore/config/default.json).

You can change any of your configuration by changing it in your local `config.json` file.

Notes
-----

### `APP_ENV`

All Spore implementations are supposed to translate the more general `APP_ENV` environment variable into a framework
or language specific equivalent. This module translates `APP_ENV` to `NODE_ENV` based on the popularity of Express.js,
the framework that popularized its usage.

Contributing
------------
1. Fork
2. Branch
3. Write Code (& Tests)
4. Submit a Pull Request

---
_Source: https://npm.io/package/spore-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
