app-config

A tool for generating configuration files for static apps.

Install

yarn add @staticdeploy/app-config

Quickstart

• add the following <script> to your public/index.html:

  <script id="app-config" src="http://localhost:3456/app-config.js"></script>

• access the config variable in your code:

  console.log(window.APP_CONFIG.MY_VAR);

Then:

In development

• define configuration in the .env file:

  APP_CONFIG_MY_VAR=my_val

• start the development server with $(npm bin)/dev-config-server

In production

• build your app and get the path of the app's index.html (for example, for apps built with create-react-app the path is build/index.html)

• defining configuration via environment variables:

  export APP_CONFIG_MY_VAR=my_val

• inject the configuration into the index file by running:

  $(npm bin)/inject-config --file path/to/index.html

Additional documentation

• how window.APP_CONFIG is generated
• inject-config cli options
• dev-config-server cli options