@alpeshabitat/matomo v1.0.0

matomo

Micro librairie permettant d'utiliser facilement l'outil Matomo

⚠️ Attention ⚠️ La documentation est écrite pour une utilisation avec Symfony mais est compatible avec n'importe quel projet.

Utilisation

Installation

L'utilisation de la librairie se veux le plus simple possible. Installez la avec

npm install @alpeshabitat/matomo

Utilisation

Importez la librairie dans votre fichier JavaScript

import matomo from '@alpeshabitat/matomo'

Il faut ensuite l'activer

matomo()

On peut également passer un objet de configuration pour modifier certains paramètres si besoin. Voici les valeurs par défaut et leur utilité.

matomo({
    debug: false, // Active le mode debug qui affiche les erreurs et les infos envoyées à matomo dans la console
    trackerUrl: null, // Url du tracker de matomo (ex: https://matomo.example.com)
    siteId: null, // Id du site sur matomo
    userId: null // Id de l'utilisateur sur matomo (ex: nom prenom de l'utilisateur connecté)
})

Les éléments de configuration ne sont la que pour les cas particuliers. Si vous n'avez pas besoin de les modifier, vous pouvez simplement utiliser la librairie sans les passer en paramètre. Dans ce cas, il est nécessaire de placer un span avec l'id matomo-data dans votre page HTML. Ce span doit contenir les données suivantes :

<span 
    id="matomo-data"
	data-user-id="{{app.user}}" // C'est un exemple, vous pouvez mettre ce que vous voulez
	data-tracker-url="{{tracker_url}}"
	data-site-id="{{tracker_site_id}}"
>
</span>

Les données sont récupérées depuis ce span et sont utilisées pour l'initialisation de la librairie.

Dans votre fichier de config twig.yaml, il faut ajouter les données utilisées ci-dessus.

twig:
    globals:
        tracker_url: '%env(TRACKER_URL)%'
        tracker_site_id: '%env(TRACKER_SITE_ID)%'

Enfin, il faut ajouter les variables d'environnement dans votre fichier .env

###> MATOMO ###
TRACKER_URL=""
TRACKER_SITE_ID=
###< MATOMO ###

Et c'est tout!

👾 Environnement de développement

🏁 Pré-requis

• NPM/Nodejs

🤝 Contribuer au projet

Dans le dossier du projet Lancer la commande

npm install

Il est possible de tester facilement le paquet en l'installant dans un autre projet avec la commande

npm install /chemin/complet/vers/le/dossier/de/matomo

Les changements s'appliqueront en temps réel (après avoir fait un npm run build)

📃 Règles de codage

• Le projet utilise une configuration prettier disponible dans le fichier prettierrc, il faut donc installer l'extension Prettier sur VsCode
• Indentation = 4 espaces

🔍 Merge Request

Les "Merges Requests" sont les bienvenues.

Pour les changements majeurs, veuillez en discuter avec le reste de l'équipe.

Merci de ne jamais travailler directement dans la branche main.

🏛 Code de Conduite

Dans l'intérêt de favoriser un environnement ouvert et accueillant, nous nous engageons à faire de la participation à ce projet une expérience exempte de harcèlement pour tout le monde, quel que soit le niveau d'expérience, le sexe, l'identité ou l'expression de genre, l'orientation sexuelle, le handicap, l'apparence personnelle, la taille physique, l'origine ethnique, l'âge, la religion ou la nationalité.