{"id":20893988,"url":"https://github.com/mautic/recommended-project","last_synced_at":"2026-03-03T18:06:29.864Z","repository":{"id":39994428,"uuid":"351793642","full_name":"mautic/recommended-project","owner":"mautic","description":"This project template provides a starter kit for managing your Mautic dependencies with Composer.","archived":false,"fork":false,"pushed_at":"2026-01-20T17:19:03.000Z","size":259,"stargazers_count":9,"open_issues_count":8,"forks_count":22,"subscribers_count":12,"default_branch":"7.x","last_synced_at":"2026-01-21T02:23:30.074Z","etag":null,"topics":["composer","mautic","php"],"latest_commit_sha":null,"homepage":"https://www.mautic.org","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mautic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-03-26T13:36:42.000Z","updated_at":"2026-01-20T17:19:08.000Z","dependencies_parsed_at":"2023-12-15T16:04:25.665Z","dependency_job_id":"adad899e-c40a-43d8-9321-0e2843e913f8","html_url":"https://github.com/mautic/recommended-project","commit_stats":{"total_commits":70,"total_committers":7,"mean_commits":10.0,"dds":0.6428571428571428,"last_synced_commit":"1ade5cda31c79b4f658c4ab753b7e9dd0da3ba92"},"previous_names":[],"tags_count":54,"template":false,"template_full_name":null,"purl":"pkg:github/mautic/recommended-project","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mautic%2Frecommended-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mautic%2Frecommended-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mautic%2Frecommended-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mautic%2Frecommended-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mautic","download_url":"https://codeload.github.com/mautic/recommended-project/tar.gz/refs/heads/7.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mautic%2Frecommended-project/sbom","scorecard":{"id":628649,"data":{"date":"2025-08-11","repo":{"name":"github.com/mautic/recommended-project","commit":"e963515bdac9926bf6e47b1b577443ef0d2aceac"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":6,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":10,"reason":"17 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-21T07:13:17.556Z","repository_id":39994428,"created_at":"2025-08-21T07:13:17.556Z","updated_at":"2025-08-21T07:13:17.556Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29061049,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T23:14:54.203Z","status":"ssl_error","status_checked_at":"2026-02-03T23:14:50.873Z","response_time":96,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["composer","mautic","php"],"created_at":"2024-11-18T10:17:49.765Z","updated_at":"2026-03-03T18:06:29.858Z","avatar_url":"https://github.com/mautic.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Composer template for Mautic projects\n\nThis project template provides a starter kit for managing your Mautic\ndependencies with [Composer](https://getcomposer.org/).\n\n## Usage\n\nFirst you need to install [Composer v2](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx).\n\n\u003e Note: The instructions below refer to the [global composer installation](https://getcomposer.org/doc/00-intro.md#globally).\nYou might need to replace `composer` with `php composer.phar` (or similar)\nfor your setup.\n\nAfter that you can create the project:\n\n```\ncomposer create-project mautic/recommended-project:^7.0 some-dir --no-interaction\n```\n\nWith `composer require ...` you can download new dependencies to your installation.\n\nExample of installing a plugin:\n```\ncd some-dir\ncomposer require mautic/helloworld-bundle\n```\n\nThe `composer create-project` command passes ownership of all files to the\nproject that is created. You should create a new git repository, and commit\nall files not excluded by the .gitignore file.\n\n## What does the template do?\n\nWhen installing the given `composer.json` some tasks are taken care of:\n\n* Mautic will be installed in the `docroot`-directory.\n* Autoloader is implemented to use the generated composer autoloader in `vendor/autoload.php`,\n  instead of the one provided by Mautic (`docroot/vendor/autoload.php`).\n* Plugins (packages of type `mautic-plugin`) will be placed in `docroot/plugins/`\n* Themes (packages of type `mautic-theme`) will be placed in `docroot/themes/`\n* Creates `docroot/media`-directory.\n* Creates environment variables based on your .env file. See [.env.example](.env.example).\n\n## Updating Mautic Core\n\nThis project will attempt to keep all of your Mautic Core files up-to-date; the\nproject [mautic/core-composer-scaffold](https://github.com/mautic/core-composer-scaffold)\nis used to ensure that your scaffold files are updated every time mautic/core is\nupdated. If you customize any of the \"scaffolding\" files (commonly .htaccess),\nyou may need to merge conflicts if any of your modified files are updated in a\nnew release of Mautic core.\n\nFollow the steps below to update your core files.\n\n1. Run `composer update mautic/core --with-dependencies` to update Mautic Core and its dependencies.\n2. Run `git diff` to determine if any of the scaffolding files have changed.\n   Review the files for any changes and restore any customizations to\n  `.htaccess` or others.\n1. Commit everything all together in a single commit, so `docroot` will remain in\n   sync with the `core` when checking out branches or running `git bisect`.\n1. In the event that there are non-trivial conflicts in step 2, you may wish\n   to perform these steps on a branch, and use `git merge` to combine the\n   updated core files with your customized files. This facilitates the use\n   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;\n   keeping all of your modifications at the beginning or end of the file is a\n   good strategy to keep merges easy.\n\n## FAQ\n\n### Should I commit the contributed plugins I download?\n\nComposer recommends **no**. They provide [argumentation against but also\nworkrounds if a project decides to do it anyway](https://getcomposer.org/doc/faqs/should-i-commit-the-dependencies-in-my-vendor-directory.md).\n\n### Should I commit the scaffolding files?\n\nThe [Mautic Composer Scaffold](https://github.com/mautic/core-composer-scaffold) plugin can download the scaffold files (like\nindex.php, .htaccess, …) to the docroot/ directory of your project. If you have not customized those files you could choose\nto not check them into your version control system (e.g. git). If that is the case for your project it might be\nconvenient to automatically run the mautic-scaffold plugin after every install or update of your project. You can\nachieve that by registering `@composer mautic:scaffold` as post-install and post-update command in your composer.json:\n\n```json\n\"scripts\": {\n    \"post-install-cmd\": [\n        \"@composer mautic:scaffold\",\n        \"...\"\n    ],\n    \"post-update-cmd\": [\n        \"@composer mautic:scaffold\",\n        \"...\"\n    ]\n},\n```\n### How can I apply patches to downloaded plugins?\n\nIf you need to apply patches (depending on the project being modified, a pull\nrequest is often a better solution), you can do so with the\n[composer-patches](https://github.com/cweagans/composer-patches) plugin.\n\nTo add a patch to Mautic plugin foobar insert the patches section in the extra\nsection of composer.json:\n```json\n\"extra\": {\n    \"patches\": {\n        \"mautic/foobar\": {\n            \"Patch description\": \"URL or local path to patch\"\n        }\n    }\n}\n```\n\n### How do I specify a PHP version?\n\nThis project supports PHP 8.2 as the minimum version (see [Mautic requirements](https://mautic.org/mautic-requirements/)). However, running a `composer update` may upgrade some package that will require a higher PHP version.\n\nTo prevent this, you can specify the PHP version in the `config` section of `composer.json` by adding the following code:\n```json\n\"config\": {\n    \"sort-packages\": true,\n    \"platform\": {\n        \"php\": \"8.2\"\n    }\n},\n```\n\nAlternatively, you can run the following command:\n```bash\ncomposer config platform.php 8.2\n```\n\n\n### How do I use another folder than docroot as webroot?\n\nBy default the composer.json file is configures to put all Mautic core, plugin and theme files in the `docroot` folder.  \nIt is possible to change this folder to your own needs.\n\nIn following examples, we will change `docroot` into `public`.\n\n#### New installations\n\n* Run the `create-project` command without installing  \n  ```bash\n  composer create-project mautic/recommended-project:^7.0 some-dir --no-interaction --no-install\n  ```\n* Do a find and replace in the `composer.json` file to change `docroot/` into `public/`.\n* Review the changes in the `composer.json` file to ensure there are no unintentional replacements.\n* Run `composer install` to install all dependencies in the correct location.\n\n#### Existing installations\n\n* move the `docroot/` to `public/`\n  ```bash\n  mv docroot public\n  ```\n* Do a find and replace in the `composer.json` file to change `docroot/` into `public/`.\n* review the changes in the `composer.json` file to ensure there are no unintentional replacements.\n* run `composer update --lock` to ensure the autoloader is aware of the changed folder.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmautic%2Frecommended-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmautic%2Frecommended-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmautic%2Frecommended-project/lists"}