mapo

Mapomodul

Aufstellen

Fügen Sie Ihrem Projekt mapomodule Abhängigkeit hinzu

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

Fügen Sie Mapomodule zum Abschnitt „Module“ von nuxt.config.js hinzu

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

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

Sie können Optionen auch über nuxt.config.js der obersten Ebene hinzufügen

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

Integrationen

Dieses Modul wurde erstellt, um die Erstellung von Administrationspanels zu vereinfachen.

Mapo wurde als Frontend-Begleiter des Camomilla-Projekts geboren, wurde jedoch mit dem Ziel erstellt, unabhängig vom Backend zu sein. Aus diesem Grund haben wir die mit dem Camomilla-Projekt verknüpfte Logik (Camomilla-Integrationen) in eine Kompatibilitätsschicht eingebettet.

Wenn Sie das Projekt mit Camomilla als Backend ausprobieren möchten, befolgen Sie einfach die Anweisungen, die Sie hier finden. Ansonsten können Sie Ihr Backend mit dem Framework und der Sprache schreiben, die Sie bevorzugen. Sie können auch neue Integrationen schreiben, um Mapo mit anderen vorhandenen API-Backends zu verbinden.

Merkmale

• Macht die Kerndienste $mapo verfügbar, um eine Reihe von Dienstprogrammen bereitzustellen.
• Fügt Mapo- components in die standardmäßige Nuxt-Komponentenerkennung ein.
• Fügt Metainformationen von Nuxt-Seiten zum Router-Modul hinzu.

? Lesen Sie mehr aus der Dokumentation.

So können Sie einen Beitrag leisten

1. Klonen Sie dieses Repository
2. Installieren Sie Abhängigkeiten mit yarn bootstrap
3. Starten Sie den Entwicklungsserver mit yarn dev

Fühlen Sie sich frei, zum Projekt beizutragen, indem Sie eine Pull-Anfrage stellen.

Hier ist ein Beispiel für eine Zweigbenennung:

feature/<branch name>

Sobald Sie mit Ihrer Arbeit fertig sind und bereit sind, eine Pull-Anfrage zu stellen, weisen Sie Gabriele Baldi (bnznamco) und Andrea Morosi (andreamorosi) als Prüfer zu.

Komponenten dokumentieren

Schreiben Sie immer eine Dokumentation zu den Komponenten, die Sie entwickeln. Unsere Dokumentation wird dank @Vuepress, @Vuese und @jsdoc-to-markdown direkt aus Code generiert.

1. Generieren Sie Doc yarn doc:gen
2. Vorschau vuepress doc yarn doc:dev

Testen

Das Projekt wird mit einer vorinstallierten Cypress-Suite geliefert. Die Anzahl der derzeit vorhandenen E2E-/Unit-Tests ist gering. Deshalb laden wir Mitwirkende ein, sowohl Tests als auch neue Funktionen zu schreiben.