https://github.com/mediafellows/mfx-ui-config

Frontend deploy configs
https://github.com/mediafellows/mfx-ui-config

configuration frontend library npm-package

Last synced: 1 day ago
JSON representation

Frontend deploy configs

• Host: GitHub
• URL: https://github.com/mediafellows/mfx-ui-config
• Owner: mediafellows
• Created: 2020-03-26T13:27:24.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-30T14:37:08.000Z (11 days ago)
• Last Synced: 2025-01-30T15:35:00.976Z (11 days ago)
• Topics: configuration, frontend, library, npm-package
• Language: JavaScript
• Homepage:
• Size: 312 KB
• Stars: 0
• Watchers: 12
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![JS CI tests](https://github.com/mediafellows/mfx-ui-config/actions/workflows/validate.yml/badge.svg)](https://github.com/mediafellows/mfx-ui-config/actions/workflows/validate.yml)

# mfx-ui-config

## install

* `yarn add @mediafellows/mfx-ui-config`

* install & configure https://github.com/dbldots/scrambler

## checkout current config

this should be run very often, at least before

* every deploy

* before you first run a build, e.g. development server

to update to the latest config

## usage

### import

```javascript

// NOT @mediafellows/mfx-ui-config!

// (as this contains the encrypted values only)

import config from 'mfx-ui-config'

```

### example

```javascript

import config from 'mfx-ui-config'

const envConfig = config.env()

const projectConfig = envConfig.fetch(`repos.mfx-ui-tf1int.projects.tf1int`)

const awsProfile = envConfig.fetch('aws_profile')

...

```

## Modifying the config

For modifying the config file you need to install [scramber](https://github.com/dbldots/scrambler) to decrypt encrypted sections. Then edit the index.js file.

Also it's good to check syntax after editing using the `yarn test` task that validates the index.js file.