aurelia-environment v0.1.7

aurelia-environment

A simple .env plugin developed for use with Aurelia. 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
• Getting Started
• Configuration
• Usage
• FAQ
• Use Cases

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 is installed. This provides the platform on which the build tooling runs.

2. From the project folder, execute the following command:

   npm install

3. Ensure that Gulp is installed. If you need to install it, use the following command:

   npm install -g gulp

4. To build the code, you can now run:

   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 CLI is installed. If you need to install it, use the following command:

   npm install -g karma-cli

2. Ensure that jspm is installed. If you need to install it, use the following commnand:

   npm install -g jspm

3. Install the client-side dependencies with jspm:

   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:

   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:

   cd sample
   jspm install

2. Go back to the root of the project and use gulp to serve the sample project:

   cd ..
   gulp watch