# aurelia-environment

> An environment plugin for Aurelia.

Latest version **0.1.7** (published 2016-10-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install aurelia-environment
pnpm add aurelia-environment
yarn add aurelia-environment
bun add aurelia-environment
```

## Health

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

Positive: has types; no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.7 |
| Published | 2016-10-05 |
| First published | 2016-04-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Marc Scheib |
| Maintainers | marcscheib |
| Keywords | aurelia, environment, plugin |

## Links

- npm: https://www.npmjs.com/package/aurelia-environment
- Repository: https://github.com/MarcScheib/aurelia-environment
- Homepage: http://aurelia.io
- Issues: https://github.com/MarcScheib/aurelia-environment/issues
- npm.io page: https://npm.io/package/aurelia-environment

## Alternatives

- [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads
- [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads
- [@openveo/api](https://npm.io/package/@openveo/api.md) — 61 weekly downloads
- [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads
- [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads

## Recent versions

- 0.1.7 (latest) — 2016-10-05
- 0.1.6 — 2016-05-18
- 0.1.5 — 2016-05-10
- 0.1.4 — 2016-05-02
- 0.1.3 — 2016-04-20
- 0.1.2 — 2016-04-18
- 0.1.1 — 2016-04-18
- 0.0.2 — 2016-04-10

## README

# aurelia-environment

[![Build Status](https://travis-ci.org/MarcScheib/aurelia-environment.svg?branch=master)](https://travis-ci.org/MarcScheib/aurelia-environment) 
[![Coverage Status](https://coveralls.io/repos/MarcScheib/aurelia-environment/badge.svg?branch=master&service=github)](https://coveralls.io/github/MarcScheib/aurelia-environment?branch=master)
[![devDependency Status](https://img.shields.io/david/dev/MarcScheib/aurelia-environment.svg)](https://david-dm.org/MarcScheib/aurelia-environment#info=devDependencies)
[![npm Version](https://img.shields.io/npm/v/aurelia-environment.svg)](https://www.npmjs.com/package/aurelia-environment)

A simple .env plugin developed for use with [Aurelia](http://www.aurelia.io/). However, it can be used for any other JavaScript framework.

The plugin allows to specify key-value-pairs in an environment file and replace all hard-coded configuration by environment variables. The file can then be easily exchanged depending on deployment point.

## Documentation

- [Installation](https://github.com/MarcScheib/aurelia-environment/blob/master/doc/Installation.md)
- [Getting Started](https://github.com/MarcScheib/aurelia-environment/blob/master/doc/GettingStarted.md)
- [Configuration](https://github.com/MarcScheib/aurelia-environment/blob/master/doc/Configuration.md)
- [Usage](https://github.com/MarcScheib/aurelia-environment/blob/master/doc/Usage.md)
- [FAQ](https://github.com/MarcScheib/aurelia-environment/blob/master/doc/FAQ.md)
- [Use Cases](https://github.com/MarcScheib/aurelia-environment/blob/master/doc/UseCases.md)

## Dependencies

This plugin has no external library dependencies.

## Used By

This library is an optional plugin and can be used by any framework.

## Platform Support

This library can be used in the **browser**.

## Building The Code

To build the code, follow these steps.

1. Ensure that [NodeJS](http://nodejs.org/) is installed. This provides the platform on which the build tooling runs.
2. From the project folder, execute the following command:

  ```shell
  npm install
  ```
3. Ensure that [Gulp](http://gulpjs.com/) is installed. If you need to install it, use the following command:

  ```shell
  npm install -g gulp
  ```
4. To build the code, you can now run:

  ```shell
  gulp build
  ```
5. You will find the compiled code in the `dist` folder, available in three module formats: AMD, CommonJS and ES6.

6. See `gulpfile.js` for other tasks related to generating the docs and linting.

## Running The Tests

To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:

1. Ensure that the [Karma](http://karma-runner.github.io/) CLI is installed. If you need to install it, use the following command:

  ```shell
  npm install -g karma-cli
  ```
2. Ensure that [jspm](http://jspm.io/) is installed. If you need to install it, use the following commnand:

  ```shell
  npm install -g jspm
  ```
3. Install the client-side dependencies with jspm:

  ```shell
  jspm install
  ```
4. Ensure that you have Chrome installed. Karma runs the test suite in Chrome.

5. You can now run the tests with this command:

  ```shell
  karma start
  ```

## Running The Sample

To run the sample code using this plugin proceed with these additional steps:

1. Go to the `sample` directory and install dependencies using `jspm`:

  ```shell
  cd sample
  jspm install
  ```
2. Go back to the root of the project and use gulp to serve the sample project:

  ```shell
  cd ..
  gulp watch
  ```

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