https://github.com/marcscheib/aurelia-environment
aurelia-environment provides simple .env parsing and loading
https://github.com/marcscheib/aurelia-environment
aurelia aurelia-environment env environment environment-variables jspm plugin
Last synced: 4 months ago
JSON representation
aurelia-environment provides simple .env parsing and loading
- Host: GitHub
- URL: https://github.com/marcscheib/aurelia-environment
- Owner: MarcScheib
- License: mit
- Created: 2016-02-20T20:43:29.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-08-03T09:48:13.000Z (almost 9 years ago)
- Last Synced: 2026-01-26T18:14:20.905Z (5 months ago)
- Topics: aurelia, aurelia-environment, env, environment, environment-variables, jspm, plugin
- Language: JavaScript
- Homepage:
- Size: 183 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# aurelia-environment
[](https://travis-ci.org/MarcScheib/aurelia-environment)
[](https://coveralls.io/github/MarcScheib/aurelia-environment?branch=master)
[](https://david-dm.org/MarcScheib/aurelia-environment)
[](https://david-dm.org/MarcScheib/aurelia-environment?type=dev)
[](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
```