mapo

mapomodule

Installation

Ajoutez une dépendance mapomodule à votre projet

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

Ajoutez mapomodule à la section modules de nuxt.config.js

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

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

Vous pouvez également ajouter des options à partir du niveau supérieur nuxt.config.js

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

Intégrations

Ce module a été créé pour simplifier la création de panels d'administration.

Mapo est né en tant que compagnon frontend du projet Camomilla, mais il a été créé dans le but d'être indépendant du backend. C'est pourquoi nous avons enfermé la logique liée au projet Camomilla (camomilla-integrations) dans une couche de compatibilité.

Si vous souhaitez essayer le projet avec Camomilla comme backend, suivez simplement les instructions que vous trouverez ici. Sinon, vous pouvez écrire votre backend avec le framework et le langage que vous préférez. Vous pouvez également écrire de nouvelles intégrations pour connecter Mapo à d'autres backends d'API existants.

Caractéristiques

• Expose les services de base $mapo pour fournir un ensemble d'utilitaires.
• Injecte components mapo dans la découverte de composants Nuxt par défaut.
• Ajoute des méta-informations au module de routeur à partir des pages nuxt.

? En savoir plus dans la documentation.

Comment contribuer

1. Cloner ce référentiel
2. Installer les dépendances à l'aide yarn bootstrap
3. Démarrez le serveur de développement en utilisant yarn dev

N'hésitez pas à contribuer au projet en faisant une Pull Request.

Voici un exemple de nom de branche :

feature/<branch name>

Une fois que vous avez terminé votre travail et que vous êtes prêt à faire une Pull Request, définissez les réviseurs sur Gabriele Baldi (bnznamco) et Andrea Morosi (andreamorosi).

Documenter les composants

Rédigez toujours de la documentation concernant les composants que vous développez. Notre documentation est générée directement à partir du code grâce à @Vuepress, @Vuese et @jsdoc-to-markdown.

1. Générer du yarn doc:gen
2. Aperçu yarn doc:dev

Essai

Le projet est livré avec une suite cyprès préinstallée. Le nombre de tests e2e/unitaires présents pour l’instant est faible. Nous invitons donc les contributeurs à écrire des tests ainsi que de nouvelles fonctionnalités.