PHPackages                             eaudeweb/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. eaudeweb/drupal-project

ActiveProject[Framework](/categories/framework)

eaudeweb/drupal-project
=======================

Project template for Drupal 8 projects with composer

8.x-dev(6y ago)016[1 issues](https://github.com/eaudeweb/drupal-project/issues)[1 PRs](https://github.com/eaudeweb/drupal-project/pulls)GPL-2.0-or-laterPHPPHP >=7.0.8

Since Mar 12Pushed 6y agoCompare

[ Source](https://github.com/eaudeweb/drupal-project)[ Packagist](https://packagist.org/packages/eaudeweb/drupal-project)[ RSS](/packages/eaudeweb-drupal-project/feed)WikiDiscussions 8.x Synced 2mo ago

READMEChangelogDependencies (61)Versions (3)Used By (0)

1. Usage
--------

[](#1-usage)

### 1.1 Installing the project locally after it has been created using the composer template.

[](#11-installing-the-project-locally-after-it-has-been-created-using-the-composer-template)

1. Clone the repository
2. Run `composer install`
3. Configure the local settings files:
    - `web/sites/default/settings.local.php`
    - `robo.yml`
    - `drush/sites/self.site.yml`
4. Install the database using one of the two methods below:
    1. Run `./install.sh` script which will clone the database from the url specified in `robo.yml` file
    2. Run `./vendor/bin/drush site:install --existing-config` which will install the database using the configuration files found in `config/sync` directory

### 1.2 Creating the project for the first time

[](#12-creating-the-project-for-the-first-time)

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 eaudeweb/drupal-project:8.x-dev some-dir --no-interaction

```

With `composer require ...` you can download new dependencies to your installation.

```
cd some-dir
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.

2. What does the template do?
-----------------------------

[](#2-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`.
- Creates environment variables based on your .env file. See [.env.example](.env.example).

3. Updating Drupal Core
-----------------------

[](#3-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 `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.

4. Generate composer.json from existing project
-----------------------------------------------

[](#4-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.

5. FAQ
------

[](#5-faq)

### 5.1 Should I commit the contrib modules I download?

[](#51-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).

### 5.2 Should I commit the scaffolding files?

[](#52-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",
        "..."
    ]
},
```

### 5.3 How can I apply patches to downloaded modules?

[](#53-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"
        }
    }
}
```

### 5.4 How do I switch from packagist.drupal-composer.org to packages.drupal.org?

[](#54-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).

### 5.5 How do I specify a PHP version ?

[](#55-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

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community20

Small or concentrated contributor base

Maturity42

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 64.2% 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 ~223 days

Total

2

Last Release

2391d ago

Major Versions

7.x-dev → 8.x-dev2019-10-22

PHP version history (2 changes)7.x-devPHP >=5.3.3

8.x-devPHP >=7.0.8

### Community

Maintainers

![](https://www.gravatar.com/avatar/c740dfce079c47e84c025ae41027543e35f7a2906a330f0ee2bdc5b42e86a229?d=identicon)[cristiroma](/maintainers/cristiroma)

![](https://www.gravatar.com/avatar/2c53359423740cf0a7081222887b60408692abc341c5bb68936d97ec40282738?d=identicon)[tavib47](/maintainers/tavib47)

---

Top Contributors

[![webflo](https://avatars.githubusercontent.com/u/123946?v=4)](https://github.com/webflo "webflo (136 commits)")[![tavib47](https://avatars.githubusercontent.com/u/11833801?v=4)](https://github.com/tavib47 "tavib47 (17 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 (5 commits)")[![derhasi](https://avatars.githubusercontent.com/u/118502?v=4)](https://github.com/derhasi "derhasi (4 commits)")[![jmolivas](https://avatars.githubusercontent.com/u/366275?v=4)](https://github.com/jmolivas "jmolivas (3 commits)")[![jorissteyn](https://avatars.githubusercontent.com/u/448056?v=4)](https://github.com/jorissteyn "jorissteyn (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)")[![jcnventura](https://avatars.githubusercontent.com/u/329663?v=4)](https://github.com/jcnventura "jcnventura (2 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)")[![zaporylie](https://avatars.githubusercontent.com/u/1690685?v=4)](https://github.com/zaporylie "zaporylie (2 commits)")[![tostinni](https://avatars.githubusercontent.com/u/585338?v=4)](https://github.com/tostinni "tostinni (1 commits)")[![tstoeckler](https://avatars.githubusercontent.com/u/3929504?v=4)](https://github.com/tstoeckler "tstoeckler (1 commits)")[![mikran](https://avatars.githubusercontent.com/u/820244?v=4)](https://github.com/mikran "mikran (1 commits)")[![clouseau](https://avatars.githubusercontent.com/u/456917?v=4)](https://github.com/clouseau "clouseau (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)")

### Embed Badge

![Health badge](/badges/eaudeweb-drupal-project/health.svg)

```
[![Health](https://phpackages.com/badges/eaudeweb-drupal-project/health.svg)](https://phpackages.com/packages/eaudeweb-drupal-project)
```

###  Alternatives

[voidagency/vactory_starter_kit

Vactory is a custom Drupal profile which is developed and released by VOID Agency.

1019.7k](/packages/voidagency-vactory-starter-kit)[drupalwxt/wxt

Project template for Drupal 10 sites built with the WxT distribution.

29159.8k8](/packages/drupalwxt-wxt)[govcms/govcms

GovCMS Drupal Distribution

18997.1k3](/packages/govcms-govcms)[thunder/thunder-distribution

The thunder distribution

50634.8k3](/packages/thunder-thunder-distribution)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)