README.md

Global Cloud Config

Manage your cloud configuration with ease to build API-driven modern web apps.

Installation

npm install cloud-configuration

or

yarn add cloud-configuration

Upgrade

npm update cloud-configuration

or

yarn upgrade cloud-configuration

Basic Usage

import cloudConfig from 'cloud-configuration';

const configs = await cloudConfig.fetchAll();

// return value or null for default projectName & default groupName
const auFlagUrl = cloudConfig.get({ configs, featureKey: 'au_flag_url' });

// return typed value or default value, good for TypeScript
const usFlagUrl = cloudConfig.getWithDefault({
  configs,
  featureKey: 'us_flag_url',
  defaultValue: 'https://example.com/us.png',
});

// not default projectName & not default groupName
const auFlagUrl = cloudConfig.get({
  configs,
  projectName: 'my-project-001',
  groupName: 'my-group-002',
  featureKey: 'au_flag_url',
});

Local .env examples

CLOUD_CONFIG_SERVER_ENCRYPT_SECRET=S_+2/QGV3Xz
CLOUD_CONFIG_SERVER_ACCESS_TOKEN=PRIVATE_U2FsdGVkX1/V6tnPtjtXIy9pX9oVKt1M73fasTvAsFpaQtvZg==
NEXT_PUBLIC_CLOUD_CONFIG_CLIENT_ENCRYPT_SECRET=C_/uTPZ+2Qrr
NEXT_PUBLIC_CLOUD_CONFIG_ORG_ID=U2FsdGVkX1/1dETBp2nedJo/uDqXrpc=

Whole package size

• package size: < 10 kB

Demo projects using Global Cloud Config

• HiHB

License

MIT