Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mautic/recommended-project
This project template provides a starter kit for managing your Mautic dependencies with Composer.
https://github.com/mautic/recommended-project
composer mautic php
Last synced: 3 days ago
JSON representation
This project template provides a starter kit for managing your Mautic dependencies with Composer.
- Host: GitHub
- URL: https://github.com/mautic/recommended-project
- Owner: mautic
- Created: 2021-03-26T13:36:42.000Z (almost 4 years ago)
- Default Branch: 5.x
- Last Pushed: 2024-10-18T14:00:33.000Z (2 months ago)
- Last Synced: 2024-10-29T18:48:38.491Z (about 2 months ago)
- Topics: composer, mautic, php
- Homepage: https://www.mautic.org
- Size: 186 KB
- Stars: 8
- Watchers: 13
- Forks: 14
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Composer template for Mautic projects
This project template provides a starter kit for managing your Mautic
dependencies with [Composer](https://getcomposer.org/).
## Usage
First you need to [install composer 2](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx).
> Note: The instructions below refer to the [global composer installation](https://getcomposer.org/doc/00-intro.md#globally).
You might need to replace `composer` with `php 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 in `docroot/plugins/`
* Themes (packages of type `mautic-theme`) will be placed in `docroot/themes/`
* Creates `docroot/media`-directory.
* Creates environment variables based on your .env file. See [.env.example](.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](https://github.com/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.
1. Run `composer update mautic/core --with-dependencies` to update Mautic Core and its dependencies.
2. 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.
1. Commit everything all together in a single commit, so `docroot` will remain in
sync with the `core` when checking out branches or running `git bisect`.
1. 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](http://www.gitshah.com/2010/12/how-to-setup-kdiff-as-diff-tool-for-git.html). 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](https://getcomposer.org/doc/faqs/should-i-commit-the-dependencies-in-my-vendor-directory.md).
### Should I commit the scaffolding files?
The [Mautic Composer Scaffold](https://github.com/mautic/core-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:
```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](https://github.com/cweagans/composer-patches) plugin.
To add a patch to Mautic plugin foobar insert the patches section in the extra
section of composer.json:
```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`:
```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 installing
```bash
composer create-project mautic/recommended-project:^4.0 some-dir --no-interaction --no-install
```
* Do a find and replace in the `composer.json` file to change `docroot/` into `public/`.
* 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/` to `public/`
```bash
mv docroot public
```
* Do a find and replace in the `composer.json` file to change `docroot/` into `public/`.
* 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.