{"id":13852660,"url":"https://github.com/kgaut/drupal-site-scaffolder","last_synced_at":"2025-04-04T12:41:09.787Z","repository":{"id":142394831,"uuid":"47626577","full_name":"kgaut/drupal-site-scaffolder","owner":"kgaut","description":"A Drupal 7/8 websites scaffolder built on composer","archived":false,"fork":false,"pushed_at":"2016-01-05T13:56:41.000Z","size":25,"stargazers_count":4,"open_issues_count":9,"forks_count":0,"subscribers_count":2,"default_branch":"7.x","last_synced_at":"2025-02-09T22:30:49.550Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kgaut.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-12-08T14:18:14.000Z","updated_at":"2021-12-13T15:56:38.000Z","dependencies_parsed_at":"2023-03-17T02:46:19.373Z","dependency_job_id":null,"html_url":"https://github.com/kgaut/drupal-site-scaffolder","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kgaut%2Fdrupal-site-scaffolder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kgaut%2Fdrupal-site-scaffolder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kgaut%2Fdrupal-site-scaffolder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kgaut%2Fdrupal-site-scaffolder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kgaut","download_url":"https://codeload.github.com/kgaut/drupal-site-scaffolder/tar.gz/refs/heads/7.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247182337,"owners_count":20897379,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-08-04T22:01:31.011Z","updated_at":"2025-04-04T12:41:09.752Z","avatar_url":"https://github.com/kgaut.png","language":"Shell","funding_links":[],"categories":["Shell","Scaffolding Tools"],"sub_categories":["Security tools"],"readme":"# Drupal Site Scaffolder\n\n## Main goal\nEasily start a new Drupal 7 / 8 project with main modules built over composer\n\n## Dependencies\nThis *scaffolder* require **composer**, a PHP dependencies manager.\n\n\n##What it does ?\nIt will download the last 7.x or 8.x release of Drupal, and a list of useful modules.\n\nIt copy the **default.settings.php** to **settings.php**, create the **files** \nand **tmp** folder (within **sites/default**).\n\nThe **.gitignore** file is here to prevent you to put under versioning core and \nmodules. (See [.gitignore section](#gitignore) for more information.)\n\nAt the end, a script ask you if you want to create a MySQL database.\n\n##Get started\n\nOpen a terminal and move to the folder you want to use, it should be empty, then \nlaunch the command :\n\n**For Drupal 7 :**\n```composer create-project kgaut/drupal-site-scaffolder ./ \"7.*\"```\n\n**For Drupal 8 :**\n```composer create-project kgaut/drupal-site-scaffolder ./ \"8.*\"```\n\nThe script is **loooong** and it does not output much, if you wish, you can use\n```-vvv``` parameter in order to set it more verbose.\n\n**For Drupal 7 :**\n```composer create-project kgaut/drupal-site-scaffolder ./ \"7.*\" -vvv```\n\n**For Drupal 8 :**\n```composer create-project kgaut/drupal-site-scaffolder ./ \"8.*\" -vvv```\n\nIf you'd rather install it in a custom folder you can specify it with :\n\n**For Drupal 7 :**\n```composer create-project kgaut/drupal-site-scaffolder my_custom_folder \"7.*\"```\n\n**For Drupal 8 :**\n```composer create-project kgaut/drupal-site-scaffolder my_custom_folder \"8.*\"```\n\n##.gitignore\n\nAs said previously, the **.gitignore** file is here to prevent you to put under \nversioning core and modules. \n\nThe modules within **sites/\\*/modules/contrib/** are excluded, your customs \nmodules has to be under **sites/\\*/modules/** in order to not being ignored. \n(ie : **sites/all/modules/my_module** will be versioned but not \n**sites/all/modules/contrib/views**)\n\nSame thing for themes, within **sites/\\*/themes/contrib/** are excluded, those \nunder **sites/\\*/theme/** are not. \n(ie : **sites/all/themes/my_theme** will be versioned but not \n**sites/all/themes/contrib/zen**)\n\n##Add contributed modules and themes\nComposer use the **[Drupal Packagist](https://packagist.drupal-composer.org/)** \nrepository in order to download / update modules.\n\nIf you want to add a module or a theme, let's say \n**[zen base theme](https://packagist.drupal-composer.org/packages/drupal/zen)** \nfor example type the following command : \n```\ncomposer require drupal/zen:\"7.*\"\n```\n\n##Update drupal core and contrib modules\n\nIn order to update core and modules, you should launch the command\n```\ncomposer update\n```\nIt will update the composer.lock file with the new version for updated \ndependencies.\n\nIf you prefer to check the available updates you can do a __dry run__ :  \n```\ncomposer update --dry-run\n```\nthis will only simulate the changes.\n\nAlso you can update only one dependency by specifying it : \n\n```\ncomposer update drupal/zen\n```\n\n##Use patchs for core and modules\nIf you need to patch core or a module, thanks to **cweagans/composer-patches**, \nyou can !\n\nWithin the **patches** section add and adapt the following example :\n\n```\n\"drupal/twitter\": {\n  \"Allow to add tracking arguments to URL\": \"https://www.drupal.org/files/issues/twitter-post-allow-to-add-tracking-to-url-2582287-6.patch\"\n}\n```\n\nThe key specify the module to patch (here : **twitter**), then the array contains \na list of patches, the key is a description, the value is the path to the patch,\nit could be an url, or a relative path to a file on your system.\n\nComplete example : \n```\n\"patches\": {\n  \"drupal/twitter\": {\n    \"Allow to add tracking arguments to URL\": \"https://www.drupal.org/files/issues/twitter-post-allow-to-add-tracking-to-url-2582287-6.patch\"\n  }\n}\n```\n\n##Links\n  - [The project on Packagist](https://packagist.org/packages/kgaut/drupal-site-scaffolder)\n\n\n\n##Thanks to\nBased on the work of [webflo](https://github.com/webflo/) on [drupal-project](https://github.com/drupal-composer/drupal-project).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkgaut%2Fdrupal-site-scaffolder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkgaut%2Fdrupal-site-scaffolder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkgaut%2Fdrupal-site-scaffolder/lists"}