mautic / recommended-project
Project template for Mautic 5 projects with composer
Installs: 26 960
Dependents: 0
Suggesters: 0
Security: 0
Stars: 8
Watchers: 13
Forks: 14
Open Issues: 8
Type:project
Requires
- composer/installers: ^1.11
- mautic/core-composer-scaffold: 4.x-dev
- mautic/core-lib: 5.1.1
- mautic/core-project-message: 4.x-dev
- mautic/grapes-js-builder-bundle: 5.1.1
- mautic/plugin-clearbit: 5.1.1
- mautic/plugin-cloudstorage: 5.1.1
- mautic/plugin-crm: 5.1.1
- mautic/plugin-emailmarketing: 5.1.1
- mautic/plugin-focus: 5.1.1
- mautic/plugin-fullcontact: 5.1.1
- mautic/plugin-gmail: 5.1.1
- mautic/plugin-outlook: 5.1.1
- mautic/plugin-social: 5.1.1
- mautic/plugin-tagmanager: 5.1.1
- mautic/plugin-zapier: 5.1.1
- mautic/theme-aurora: 5.1.1
- mautic/theme-blank: 5.1.1
- mautic/theme-brienz: 5.1.1
- mautic/theme-cards: 5.1.1
- mautic/theme-confirmme: 5.1.1
- mautic/theme-fresh-center: 5.1.1
- mautic/theme-fresh-fixed: 5.1.1
- mautic/theme-fresh-left: 5.1.1
- mautic/theme-fresh-wide: 5.1.1
- mautic/theme-goldstar: 5.1.1
- mautic/theme-neopolitan: 5.1.1
- mautic/theme-oxygen: 5.1.1
- mautic/theme-paprika: 5.1.1
- mautic/theme-skyline: 5.1.1
- mautic/theme-sparse: 5.1.1
- mautic/theme-sunday: 5.1.1
- mautic/theme-trulypersonal: 5.1.1
- mautic/theme-vibrant: 5.1.1
Conflicts
- mautic/core: *
- mautic/mautic: *
README
This project template provides a starter kit for managing your Mautic dependencies with Composer.
Usage
First you need to install composer 2.
Note: The instructions below refer to the global composer installation. You might need to replace
composer
withphp composer.phar
(or similar) for your setup.
After that you can create the project:
composer create-project mautic/recommended-project:^5.0 some-dir --no-interaction
With composer require ...
you can download new dependencies to your installation.
Example of installing a plugin:
cd some-dir
composer require mautic/helloworld-bundle
The composer create-project
command passes ownership of all files to the
project that is created. You should create a new git repository, and commit
all files not excluded by the .gitignore file.
What does the template do?
When installing the given composer.json
some tasks are taken care of:
- Mautic will be installed in the
docroot
-directory. - Autoloader is implemented to use the generated composer autoloader in
vendor/autoload.php
, instead of the one provided by Mautic (docroot/vendor/autoload.php
). - Plugins (packages of type
mautic-plugin
) will be placed indocroot/plugins/
- Themes (packages of type
mautic-theme
) will be placed indocroot/themes/
- Creates
docroot/media
-directory. - Creates environment variables based on your .env file. See .env.example.
Updating Mautic Core
This project will attempt to keep all of your Mautic Core files up-to-date; the project mautic/core-composer-scaffold is used to ensure that your scaffold files are updated every time mautic/core is updated. If you customize any of the "scaffolding" files (commonly .htaccess), you may need to merge conflicts if any of your modified files are updated in a new release of Mautic core.
Follow the steps below to update your core files.
- Run
composer update mautic/core --with-dependencies
to update Mautic Core and its dependencies. - Run
git diff
to determine if any of the scaffolding files have changed. Review the files for any changes and restore any customizations to.htaccess
or others. - Commit everything all together in a single commit, so
docroot
will remain in sync with thecore
when checking out branches or runninggit bisect
. - In the event that there are non-trivial conflicts in step 2, you may wish
to perform these steps on a branch, and use
git merge
to combine the updated core files with your customized files. This facilitates the use of a three-way merge tool such as kdiff3. This setup is not necessary if your changes are simple; keeping all of your modifications at the beginning or end of the file is a good strategy to keep merges easy.
FAQ
Should I commit the contributed plugins I download?
Composer recommends no. They provide argumentation against but also workrounds if a project decides to do it anyway.
Should I commit the scaffolding files?
The Mautic Composer Scaffold plugin can download the scaffold files (like
index.php, .htaccess, …) to the docroot/ directory of your project. If you have not customized those files you could choose
to not check them into your version control system (e.g. git). If that is the case for your project it might be
convenient to automatically run the mautic-scaffold plugin after every install or update of your project. You can
achieve that by registering @composer mautic:scaffold
as post-install and post-update command in your composer.json:
"scripts": { "post-install-cmd": [ "@composer mautic:scaffold", "..." ], "post-update-cmd": [ "@composer mautic:scaffold", "..." ] },
How can I apply patches to downloaded plugins?
If you need to apply patches (depending on the project being modified, a pull request is often a better solution), you can do so with the composer-patches plugin.
To add a patch to Mautic plugin foobar insert the patches section in the extra section of composer.json:
"extra": { "patches": { "mautic/foobar": { "Patch description": "URL or local path to patch" } } }
How do I specify a PHP version ?
This project supports PHP 7.4 as minimum version, however it's possible that a composer update
will upgrade some package that will then require PHP 7+ or 8+.
To prevent this you can add this code to specify the PHP version you want to use in the config
section of composer.json
:
"config": { "sort-packages": true, "platform": { "php": "7.4" } },
How do I use another folder than docroot as webroot
By default the composer.json file is configures to put all Mautic core, plugin and theme files in the docroot
folder.
It is possible to change this folder to your own needs.
In following examples, we will change docroot
into public
.
New installations
- Run the
create-project
command without installingcomposer create-project mautic/recommended-project:^4.0 some-dir --no-interaction --no-install
- Do a find and replace in the
composer.json
file to changedocroot/
intopublic/
. - Review the changes in the
composer.json
file to ensure there are no unintentional replacements. - Run
composer install
to install all dependencies in the correct location.
Existing installations
- move the
docroot/
topublic/
mv docroot public
- Do a find and replace in the
composer.json
file to changedocroot/
intopublic/
. - review the changes in the
composer.json
file to ensure there are no unintentional replacements. - run
composer update --lock
to ensure the autoloader is aware of the changed folder.