npm package: @property-management/modular-nuxt
Description: Nuxt modular management
Author: Ricardo Gobbo de Souza
Latest version: 1.0.0
Deprecated: false

# Nuxt Modular

[![NPM Version](https://img.shields.io/npm/v/@property-management/modular-nuxt.svg)](https://www.npmjs.com/package/@property-management/modular-nuxt)
[![Downloads](https://img.shields.io/npm/dt/@property-management/modular-nuxt.svg)](https://www.npmjs.com/package/@property-management/modular-nuxt)
[![MIT License](https://img.shields.io/npm/l/@property-management/modular-nuxt.svg)](LICENSE)

[![Build Status](https://travis-ci.org/property-management/modular-nuxt.svg?branch=master)](https://travis-ci.org/property-management/modular-nuxt)
[![Build status](https://ci.appveyor.com/api/projects/status/o2g6m42r70vdltlq/branch/master?svg=true)](https://ci.appveyor.com/project/property-management/modular-nuxt/branch/master)
[![Coverage Status](https://coveralls.io/repos/github/property-management/modular-nuxt/badge.svg?branch=master)](https://coveralls.io/github/property-management/modular-nuxt?branch=master)

[![Code Climate](https://codeclimate.com/github/property-management/modular-nuxt/badges/gpa.svg)](https://codeclimate.com/github/property-management/modular-nuxt)
[![Test Coverage](https://codeclimate.com/github/property-management/modular-nuxt/badges/coverage.svg)](https://codeclimate.com/github/property-management/modular-nuxt/coverage)
[![Issue Count](https://codeclimate.com/github/property-management/modular-nuxt/badges/issue_count.svg)](https://codeclimate.com/github/property-management/modular-nuxt)

[![Dependencies Status](https://david-dm.org/property-management/modular-nuxt/status.svg)](https://david-dm.org/property-management/modular-nuxt)
[![devDependencies Status](https://david-dm.org/property-management/modular-nuxt/dev-status.svg)](https://david-dm.org/property-management/modular-nuxt?type=dev)
[![peerDependencies Status](https://david-dm.org/property-management/modular-nuxt/peer-status.svg)](https://david-dm.org/property-management/modular-nuxt?type=peer)

[![Semantic Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/property-management/modular-nuxt.svg)](http://isitmaintained.com/project/property-management/modular-nuxt)
[![Percentage of issues still open](http://isitmaintained.com/badge/open/property-management/modular-nuxt.svg)](http://isitmaintained.com/project/property-management/modular-nuxt)
[![Gitter](https://badges.gitter.im/property-management/modular-nuxt.svg)](https://gitter.im/property-management/modular-nuxt?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

> Nuxt modular management

## Install

```bash
npm install --save @property-management/modular-nuxt
```

Add `@property-management/modular-nuxt` to modules section of `nuxt.config.js`:

```js
{
    modules: [
        '@property-management/modular-nuxt'
    ]
}
```

## Usage

This module allows you to build your app in modules.
By default the folders within `modular` will be considered modules and within each module you can use the same root structure, that is, your module can contain
`layouts`, `middleware`, `plugins`, `pages`, `static`, `store`.

Ex:

```bash
modular
    example1
        pages
            index.vue
    example2
        pages
            index.vue
pages
    index.vue
```

You should be able to access this:

```bash
/ -> pages/index.vue
/example1 -> modular/example1/pages/index.vue
/example2 -> modular/example2/pages/index.vue
```