PHPackages bixal/drupal-project - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. bixal/drupal-project ActiveProject[Framework](/categories/framework) bixal/drupal-project ==================== Project template for Drupal 8 projects with composer and minimal docker configuration 9.x-dev(5y ago)51635[1 issues](https://github.com/Bixal/drupal-project/issues)[1 PRs](https://github.com/Bixal/drupal-project/pulls)GPL-2.0-or-laterPHPPHP >=7.3.0 Since May 6Pushed 5y ago10 watchersCompare [ Source](https://github.com/Bixal/drupal-project)[ Packagist](https://packagist.org/packages/bixal/drupal-project)[ RSS](/packages/bixal-drupal-project/feed)WikiDiscussions 9.x Synced 3d ago READMEChangelogDependencies (8)Versions (7)Used By (0) Composer template for Drupal projects ===================================== [](#composer-template-for-drupal-projects) [![CircleCI](https://camo.githubusercontent.com/42e79a636f345ad64f5437052741f8afc1ccd0c1b28c45d8e25e320e1e8afa77/68747470733a2f2f636972636c6563692e636f6d2f67682f426978616c2f64727570616c2d70726f6a6563742f747265652f392e782e7376673f7374796c653d737667)](https://circleci.com/gh/Bixal/drupal-project/tree/9.x) This project template provides a starter kit for managing your site and environment dependencies with [Composer](https://getcomposer.org/) and [Docker](https://www.docker.com/). It is an opinionated fork of [Drupal Project](https://github.com/drupal-composer/drupal-project) with elements of [docker4drupal](https://github.com/wodby/docker4drupal). This is a non-production package meant to be a quick start best practices in Drupal, while a proper CI/CD and docker images are being developed. Using this package *as is* may lead to build issues later on. Always prioritize building your own docker application images (perhaps using the excellent docker4drupal package this starter is built on) to practice a proper CI/CD. It assumes you are developing on OS X however you can review the .env and docker-compose volume keys to work with a linux distribution of choice. [docker4drupal docs for OSX](https://wodby.com/stacks/drupal/docs/local/docker-for-mac/) Usage ----- [](#usage) First you need to [install composer](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 bixal/drupal-project:9.x-dev some-dir --stability dev --no-interaction ``` Where `some-dir` is the name you want to give to your project directory. Before proceeding, make sure you change directories by going into your new project directory: ``` cd some-dir ``` Copy .env.example to .env: ``` cp .env.example .env ``` After that you can run make composer. The provided [Makefile](Makefile) has 2 commands you may run for installing composer dependencies: ``` make install # To run a normal composer install. ``` or ``` make install-source # To install composer dependencies with source to work on contributed projects. ``` Installing from source can take several minutes or more depending on your network connection. Edit your /etc/hosts file: ``` sudo sh -c "echo '127.0.0.1 mysitename' >> /etc/hosts" ``` Replace mysitename with PROJECT\_BASE\_URL found in .env Finally, run the command 'make up' to start the container for the project: ``` make up ``` You should be able to navigate to mysitename.localhost:8000 With `docker-compose run php composer require ...` you can download new dependencies to your installation. ``` cd some-dir docker-compose run php composer require drupal/devel:~1.0 ``` 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? -------------------------- [](#what-does-the-template-do) When installing the given `composer.json` some tasks are taken care of: - Drupal will be installed in the `web`-directory. - Autoloader is implemented to use the generated composer autoloader in `vendor/autoload.php`, instead of the one provided by Drupal (`web/vendor/autoload.php`). - Modules (packages of type `drupal-module`) will be placed in `web/modules/contrib/` - Theme (packages of type `drupal-theme`) will be placed in `web/themes/contrib/` - Profiles (packages of type `drupal-profile`) will be placed in `web/profiles/contrib/` - Creates default writable versions of `settings.php` and `services.yml`. - Creates `web/sites/default/files`-directory. - Latest version of drush is installed locally for use at `vendor/bin/drush`. - Latest version of DrupalConsole is installed locally for use at `vendor/bin/drupal`. - Provides [.env.example](.env.example) which can be copied to .env for environment variables. Updating Drupal Core -------------------- [](#updating-drupal-core) This project will attempt to keep all of your Drupal Core files up-to-date; the project [drupal-composer/drupal-scaffold](https://github.com/drupal-composer/drupal-scaffold)is used to ensure that your scaffold files are updated every time drupal/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 Drupal core. Follow the steps below to update your core files. 1. Run `docker-compose run php composer update drupal/core webflo/drupal-core-require-dev symfony/* --with-dependencies` to update Drupal 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 `robots.txt`. 3. Commit everything all together in a single commit, so `web` will remain in sync with the `core` when checking out branches or running `git bisect`. 4. 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. Generate composer.json from existing project -------------------------------------------- [](#generate-composerjson-from-existing-project) With using [the "Composer Generate" drush extension](https://www.drupal.org/project/composer_generate)you can now generate a basic `composer.json` file from an existing project. Note that the generated `composer.json` might differ from this project's file. FAQ --- [](#faq) ### Should I commit the contrib modules I download? [](#should-i-commit-the-contrib-modules-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? [](#should-i-commit-the-scaffolding-files) The [drupal-scaffold](https://github.com/drupal-composer/drupal-scaffold) plugin can download the scaffold files (like index.php, update.php, …) to the web/ 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 drupal-scaffold plugin after every install or update of your project. You can achieve that by registering `@composer drupal:scaffold` as post-install and post-update command in your composer.json: ``` "scripts": { "post-install-cmd": [ "@composer drupal:scaffold", "..." ], "post-update-cmd": [ "@composer drupal:scaffold", "..." ] }, ``` ### How can I apply patches to downloaded modules? [](#how-can-i-apply-patches-to-downloaded-modules) 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 drupal module foobar insert the patches section in the extra section of composer.json: ``` "extra": { "patches": { "drupal/foobar": { "Patch description": "URL or local path to patch" } } } ``` ### How do I switch from packagist.drupal-composer.org to packages.drupal.org? [](#how-do-i-switch-from-packagistdrupal-composerorg-to-packagesdrupalorg) Follow the instructions in the [documentation on drupal.org](https://www.drupal.org/docs/develop/using-composer/using-packagesdrupalorg). ### How do I specify a PHP version? [](#how-do-i-specify-a-php-version) This project supports PHP 7.0 as minimum version (see [Drupal 8 PHP requirements](https://www.drupal.org/docs/8/system-requirements/drupal-8-php-requirements)), however it's possible that a `composer update` will upgrade some package that will then require PHP 7+. 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.0.33" } }, ``` ### Health Score 27 — LowBetter than 49% of packages Maintenance16 Infrequent updates — may be unmaintained Popularity18 Limited adoption so far Community26 Small or concentrated contributor base Maturity45 Maturing project, gaining track record Bus Factor1 Top contributor holds 64% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~38 days Total 2 Last Release 2117d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/0f4e2de4c7c181d02116224ae6a265265c6808aee170682e6078d08dcbfbdcb5?d=identicon)[allgood2386](/maintainers/allgood2386) --- Top Contributors [![webflo](https://avatars.githubusercontent.com/u/123946?v=4)](https://github.com/webflo "webflo (135 commits)")[![allgood2386](https://avatars.githubusercontent.com/u/773957?v=4)](https://github.com/allgood2386 "allgood2386 (15 commits)")[![weitzman](https://avatars.githubusercontent.com/u/7740?v=4)](https://github.com/weitzman "weitzman (11 commits)")[![pfrenssen](https://avatars.githubusercontent.com/u/442924?v=4)](https://github.com/pfrenssen "pfrenssen (6 commits)")[![greg-1-anderson](https://avatars.githubusercontent.com/u/612191?v=4)](https://github.com/greg-1-anderson "greg-1-anderson (4 commits)")[![derhasi](https://avatars.githubusercontent.com/u/118502?v=4)](https://github.com/derhasi "derhasi (4 commits)")[![g3r4](https://avatars.githubusercontent.com/u/8062569?v=4)](https://github.com/g3r4 "g3r4 (3 commits)")[![jmolivas](https://avatars.githubusercontent.com/u/366275?v=4)](https://github.com/jmolivas "jmolivas (3 commits)")[![jonhattan](https://avatars.githubusercontent.com/u/482058?v=4)](https://github.com/jonhattan "jonhattan (2 commits)")[![MPParsley](https://avatars.githubusercontent.com/u/1823998?v=4)](https://github.com/MPParsley "MPParsley (2 commits)")[![jcnventura](https://avatars.githubusercontent.com/u/329663?v=4)](https://github.com/jcnventura "jcnventura (2 commits)")[![petk](https://avatars.githubusercontent.com/u/1614009?v=4)](https://github.com/petk "petk (2 commits)")[![bradjones1](https://avatars.githubusercontent.com/u/981966?v=4)](https://github.com/bradjones1 "bradjones1 (2 commits)")[![jorissteyn](https://avatars.githubusercontent.com/u/448056?v=4)](https://github.com/jorissteyn "jorissteyn (2 commits)")[![zaporylie](https://avatars.githubusercontent.com/u/1690685?v=4)](https://github.com/zaporylie "zaporylie (2 commits)")[![mattsqd](https://avatars.githubusercontent.com/u/1043047?v=4)](https://github.com/mattsqd "mattsqd (2 commits)")[![mickaelperrin](https://avatars.githubusercontent.com/u/5844226?v=4)](https://github.com/mickaelperrin "mickaelperrin (1 commits)")[![gagarine](https://avatars.githubusercontent.com/u/164074?v=4)](https://github.com/gagarine "gagarine (1 commits)")[![grasmash](https://avatars.githubusercontent.com/u/539205?v=4)](https://github.com/grasmash "grasmash (1 commits)")[![hussainweb](https://avatars.githubusercontent.com/u/1040271?v=4)](https://github.com/hussainweb "hussainweb (1 commits)") ### Embed Badge ![Health badge](/badges/bixal-drupal-project/health.svg) ``` [![Health](https://phpackages.com/badges/bixal-drupal-project/health.svg)](https://phpackages.com/packages/bixal-drupal-project) ``` ### Alternatives [drupal/recommended-project Project template for Drupal projects with a relocated document root 1502.6M1](/packages/drupal-recommended-project)[drupalwxt/wxt Project template for Drupal 10 sites built with the WxT distribution. 29159.8k8](/packages/drupalwxt-wxt)[drupalcommerce/project-base Commerce 2.x project template 5451.6k](/packages/drupalcommerce-project-base)[fourkitchens/sous-drupal-project Starter project for Sous a Drupal distribution featuring a theme based on Emulsify Design System. 151.0k](/packages/fourkitchens-sous-drupal-project) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)