Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pigeonposse/mautic-plugin-extra-tools

Create custom tokens, add custom nav links and more in Mautic πŸ“¬
https://github.com/pigeonposse/mautic-plugin-extra-tools

Last synced: 8 days ago
JSON representation

Create custom tokens, add custom nav links and more in Mautic πŸ“¬

Awesome Lists containing this project

README

        

# Mautic Extra Tools by PIGEONPOSSEβ„’

[![License](https://img.shields.io/github/license/PigeonPosse/mautic-plugin-extra-tools?color=blue&label=License&style=flat-square)](https://packagist.org/packages/pigeonposse/mautic-plugin-extra-tools)
[![Version](https://img.shields.io/packagist/v/pigeonposse/mautic-plugin-extra-tools?color=a1b858&label&style=flat-square)](https://packagist.org/packages/pigeonposse/mautic-plugin-extra-tools)
[![Web](https://img.shields.io/badge/Web-grey?style=flat-square)](https://pigeonposse.com/)
[![About us](https://img.shields.io/badge/About-us-grey?style=flat-square)](https://pigeonposse.com/?popup=about)
[![Donate](https://img.shields.io/badge/Donate-pink?style=flat-square)](https://pigeonposse.com/?popup=donate)

## πŸ—’ Description

This plugin adds various functionality to _Mautic_ and is inspired by others that the mautic community has developed. To learn more about the history of the project, see the [history section](https://github.com/PigeonPosse/mautic-plugin-extra-tools/blob/main/HISTORY.md).

### What does this plugin offer?
- Creation of **custom tokens** that work on both pages, emails and notifications
- Execution of **mautic commands from the interface** without having to open the terminal (still in development)
- Creation of **custom navigation links** for the main, user, administrator and extra menus

The idea of this plugin is to bring together some of the features that the community needs and that Mautic does not offer natively. So any ideas are welcome.

## πŸ— Prerequisites

1. A [_Mautic_](https://www.mautic.org/) installation.

## πŸ”‘ Installation

### πŸ“š Manual

1. Download or clone this bundle into your _Mautic_ /plugins folder.
2. Clean your _Mautic_ cache. There are two options to do that:
- Remove cache from folder "prod":
```bash
# For Mautic 3.x:
rm -r {YourMauticDirectory}/var/cache/prod
# For Mautic 2.x:
rm -r {YourMauticDirectory}/app/cache/prod
```
- Execute Mautic cache command:
```bash
# For Mautic 3.x:
php {YourMauticDirectory}/bin/console cache:clear
# For Mautic 2.x:
php {YourMauticDirectory}/app/console cache:clear
```
3. In the Mautic GUI, go to the βš™οΈ icon in the top right and then to Plugins.
4. Click the _"Install/Upgrade Plugins"_ button in the top right.

>**Note:** If you are on an older version of Mautic, click the drowpdown arrow in the top right and then choose _"Install/Upgrade Plugins"_.

5. Finally, You should now see _PigeonPosse_ plugin in your list of plugins.

## πŸ‘¨β€πŸ’» Development

- About _**Mautic**_ development:

[![Check docs](https://img.shields.io/badge/Check-docs-grey?style=flat-square)](https://developer.mautic.org/)

- About _**Symfony**_ development:

[![Check docs](https://img.shields.io/badge/Check-docs-grey?style=flat-square)](https://symfony.com/doc)

## β˜• Donate

Help us to develop more interesting things.

[![Donate](https://img.shields.io/badge/Donate-grey?style=flat-square)](https://pigeonposse.com/?popup=donate)

## πŸ“ History

Read about the history of the project.

[![Read more](https://img.shields.io/badge/Read-more-grey?style=flat-square)](https://github.com/PigeonPosse/mautic-plugin-extra-tools/blob/main/HISTORY.md)

## πŸ“œ License

This software is licensed with GPLv3 (GNU GENERAL PUBLIC LICENSE Version 3)

[![Read more](https://img.shields.io/badge/Read-more-grey?style=flat-square)](https://github.com/PigeonPosse/mautic-plugin-extra-tools/blob/main/LICENSE)

## 🐦 About us

_PigeonPosse_ is a ✨ **code development collective** ✨ focused on creating practical and interesting tools that help developers and users enjoy a more agile and comfortable experience. Our projects cover various programming sectors and we do not have a thematic limitation in terms of projects.

[![More](https://img.shields.io/badge/Read-more-grey?style=flat-square)](https://github.com/PigeonPosse/PigeonPosse)

### Collaborators

| | Name | Role | GitHub |
| ---------------------------------------------------------------------------------- | ----------- | ------------ | ---------------------------------------------- |
| | AngelEspejo | Author | [@AngelEspejo](https://github.com/AngelEspejo) |
| | PigeonPosse | Collective | [@PigeonPosse](https://github.com/PigeonPosse) |