Configuration File

Configuration Options

The configuration file is called evconfig.json containing Everflow’s global configurations. You can modify its properties listed below before bootstrapping your application:

Placement is next to your main.ts file in your root src folder.

routerMode

• Type: RouterMode

• Values: hash | history

• Usage:

Tells Everflow to use hash or history routing with Vue Router

{
  "routerMode": "hash", //or history
}

mountId

Tells Everflow what HTML ID to mount the Vue Router

• Type: string

• default: app

• Usage:

  {
    "mountId": "app",
  }

apiURL

Tells Everflow what your API entry point is

• Type: string

• default: https://api.localhost

• Usage:

  {
    "apiURL": "https://api.localhost",
  }

i18n

I18n information for your application

• Type: object

• Usage:

  {
    "i18n": {
        "enabled": <boolean>,
        "defaultLocale": "<i18n locale>",
        "fallbackLocale": "<i18n locale>",
        "modules": <boolean>
    },
  }

i18n / Options

enabled

Enables i18n loading in application

• Type: boolean

• default: true

• Usage:

  {
    "enabled": true,
  }

defaultLocale

The default i18n locale

• Type: string

• default: en

• Usage:

  {
    "defaultLocale": "en",
  }

fallbackLocale

The fallback locale for if the default locale fails. user is a custom type to Everflow and will detect the users browsers language.

• Type: string

• default: en

• values: i18n-locale | user

• Usage:

  {
    "fallbackLocale": "en",
  }

modules

I18n with modules enabled keeps all locales modules separated

• Type: boolean

• default: true

• details: true

IF true all translations must start with a module name unless stored in the root i18n folder.
$t(‘<module_name>.message.hello’)

IF `false` all translations merge and will overwrite from each module.
$t('message.hello')

• Usage:

  {
    "modules": true,
  }

security

Security information for your application

• Type: object

• Usage:

  {
    "security": {
        "key": "<256-bit-key>"
    }
  }

security / Options

key

A 256 bit key for AES encryption, generated if installed Everflow via Vue Cli 3

• Type: string

• default: <installation-generated>

• Usage:

  {
    "key": "<256-bit-key>",
  }

storage

Security information for your application

• Type: object

• Usage:

  {
    "storage": {
        "name": "<storage-name>",
        "driver": [],
        "size": <storage-size-in-bytes>,
        "storeName": "<storage-name>"
    }
  }

security / Options

TODO…

datetime

Date and time information for your application

• Type: object

• Usage:

  {
    "datetime": {
        "date": {
            "format": "<date_format>"
        },
        "time": {
            "format": "<time_format>"
        }
    }
  }

date

Moment.js date serialization format. Formats here

• Type: string

• default: YYYY-MM-DD

• Usage:

  {
    "format": "YYYY-MM-DD",
  }

time

Moment.js time serialization format. Formats here

• Type: string

• default: HH:mm:ss

• Usage:

  {
    "format": "HH:mm:ss",
  }

Example evconfig.json

{
    "routerMode": "hash",
    "mountId": "app",
    "apiURL": "https://localhost:8080",
    "i18n": {
        "enabled": true,
        "defaultLocale": "user",
        "fallbackLocale": "en",
        "modules": true
    },
    "security": {
        "key": "<AES_KEY>"
    },
    "storage": {
        "name": "everflow",
        "driver": ["asyncStorage"],
        "size": 4980736,
        "storeName": "app"
    },
    "datetime": {
        "date": {
            "format": "YYYY-MM-DD"
        },
        "time": {
            "format": "HH:mm:ss"
        }
    }
}