Skip to content

Latest commit

 

History

History
89 lines (57 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

89 lines (57 loc) · 1.93 KB

Contributing

Translation

Translation current status

Translate this plugin :

https://hosted.weblate.org/projects/matomo/communityplugin-signup/

Or translate Matomo or any plugin :

https://hosted.weblate.org/engage/matomo/

Development

To develop on this plugin, you first need to run a local instance of Matomo.

You have to clone the oldest Matomo version this plugin supports.

Install a specific version of Matomo

It requires:

  • php
  • composer
  • MariaDB or MySQL database
  • node (works better on v16 for me)

Check the minimal version of Matomo this plugin supports in plugin.json:

If you see:

  "require": {
    "piwik": ">=4.8.0,<5.0.0-b1"
  },

then you should develop on Matomo 4.8.0, here is how to install it:

git clone [email protected]:matomo-org/matomo.git --branch 4.8.0
cd matomo/

# Install dependencies
composer install

# Install frontend dependencies
npm install

# Run PHP local server
php -S 0.0.0.0:8000
# Enable development mode (to avoid assets caching and enabling vue assets building)
php console development:enable

All this part is also officially documented by Matomo:

https://developer.matomo.org/guides/getting-started-part-1

Clone Signup plugin

Once your Matomo instance is running, clone the Signup plugin inside plugins/ folder.

Asuming you forked matomo-plugin-signup:

cd plugins/

git clone [email protected]:YOUR_GITHUB_NAME/matomo-plugin-signup.git Signup
cd Signup/

Now you should be able to enable the plugin in Matomo admin interface.

If you edit frontend assets (vue, js files...), run this commands to automatically recompile assets:

# Automatically build vue assets
php console vue:build Signup --watch