nuxt-configuration

A nuxt.js module that allows us to load multiple configuration files

📖 Release Notes

Features

The module loads configurations files.

Setup

1. Add nuxt-configuration dependency to your project

yarn add nuxt-configuration # or npm install nuxt-configuration

2. Add nuxt-configuration to the modules section of nuxt.config.js

{
  modules: [
    // Simple usage
    'nuxt-configuration',

    // With options
    ['nuxt-configuration', { /* module options */ }]
  ]
}

Using top level options

{
  modules: [
    'nuxt-configuration'
  ],
  dotenv: {
    /* module options */
  }
}

Options

TODO explains options...

Usage

After creating your config files, simply run your usual yarn dev or npm run dev. You can use this.$config in your components

Using .env file in configuration files

This module won't overload the environment variables of the process running your build.

If you need to use variables from your .env file at this moment, just append require('dotenv').config() to your configuration files :

require('dotenv').config()

module.exports = {
  // your usual config.
}

Development

1. Clone this repository
2. Install dependencies using yarn install or npm install
3. Start development server using npm run dev

License

MIT License

Copyright (c) Nuxt Community