# README

The ui package

The ui package contains static files and templates used in the web UI. For easier distribution they are statically compiled into the Prometheus Remote Adapter binary using the go-bindata tool (c.f. Makefile).

During development it is more convenient to always use the files on disk to directly see changes without recompiling. Set the environment variable DEBUG=1 and run make assets for this to work. This will put go-bindata in DEBUG mode where it serves from your local filesystem. This is for development purposes only.

After making changes to any file, run make assets (without the DEBUG=1) before committing to update the generated inline version of the file.

Reload dependencies

Frontend dependencies are managed by npm and gulp. If you want to add more dependencies: update the package.json, then run gulp after updating gulpfile.js

npm install -g gulp # install CLI for GULP
npm install # install all dependencies including GULP
gulp # Run gulp using gulpfile.js

# Functions

Asset loads and returns the asset for the given name.
AssetDir returns the file names below a certain directory embedded in the file by go-bindata.
AssetInfo loads and returns the asset info for the given name.
AssetNames returns the names of the assets.
MustAsset is like Asset but panics when Asset would return an error.
RestoreAsset restores an asset under the given directory.
RestoreAssets restores an asset under the given directory recursively.