Skip to content

Latest commit

 

History

History
75 lines (53 loc) · 2.87 KB

README.md

File metadata and controls

75 lines (53 loc) · 2.87 KB
Raw

mapomodule npm GitHub Workflow Status GitHub

Setup

Add mapomodule dependency to your project

yarn add --dev mapomodule # or npm install --save-dev mapomodule

Add mapomodule to the modules section of nuxt.config.js

{
  modules: [
    // Simple usage
    'mapomodule',

    // With options
    ['mapomodule', { /* module options */ }]
  ]
}

You can add options also from top level nuxt.config.js

{
  modules: [
    'mapomodule'
  ],
  mapo: {
    /* module options */
  }
}

Integrations

This module was created to simplify the creation of administration panels.

Mapo was born as a frontend companion of the Camomilla project, but it was created with the aim of being agnostic about the backend. This is why we have enclosed the logic linked to the Camomilla project (camomilla-integrations) in a compatibility layer.

If you want to try the project with Camomilla as a backend, just follow the instructions you will find here. Otherwise you can write your backend with the framework and language you prefer. You can also write new integrations to connect Mapo to other existing api backends.

Features

  • Exposes $mapo core sevices to provide set of utilities.
  • Injects mapo components in the default nuxt component discovery.
  • Adds meta information to router module from nuxt pages.

📑  Read more from the documentation.

How to contribute

  1. Clone this repository
  2. Install dependencies using yarn bootstrap
  3. Start development server using yarn dev

Feel free to contribute to the project by making a Pull Request.

Here's an example for a branch naming:

feature/<branch name>

Once you're done with your work and are ready to make a Pull Request, set the reviewers to Gabriele Baldi (bnznamco) and Andrea Morosi (andreamorosi).

Documenting components

Always write some documentation regarding the components you're developing. Our documentation is generated directly from code thanks to @Vuepress, @Vuese and @jsdoc-to-markdown.

  1. Generate doc yarn doc:gen
  2. Preview vuepress doc yarn doc:dev

Testing

The project comes with a pre-installed cypress suite. The number of e2e/unit tests present for now is low. So we invite contributors to write tests as well as new features.