PHPackages                             drupalcommerce/project-base - 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. drupalcommerce/project-base

ActiveProject[Framework](/categories/framework)

drupalcommerce/project-base
===========================

Commerce 2.x project template

10.x-dev(2y ago)5451.7k26[5 issues](https://github.com/drupalcommerce/project-base/issues)[6 PRs](https://github.com/drupalcommerce/project-base/pulls)GPL-2.0-or-laterPHPPHP >=8.1.0

Since Apr 19Pushed 2y ago5 watchersCompare

[ Source](https://github.com/drupalcommerce/project-base)[ Packagist](https://packagist.org/packages/drupalcommerce/project-base)[ RSS](/packages/drupalcommerce-project-base/feed)WikiDiscussions 10.x Synced today

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

Commerce 2.x project template
=============================

[](#commerce-2x-project-template)

Use [Composer](https://getcomposer.org/) to get Drupal + Commerce 2.x.

Also look at [drupalcommerce/demo-project](https://github.com/drupalcommerce/demo-project)for a version with demo content.

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 drupalcommerce/project-base some-dir --stability dev --no-interaction

```

Done! Use `composer require ...` to download additional modules and themes:

```
cd some-dir
composer require "drupal/devel:1.x-dev"

```

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)

-

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

Updating Drupal Core
--------------------

[](#updating-drupal-core)

This project will attempt to keep all of your Drupal Core files up-to-date; the project [drupal/core-composer-scaffold](https://github.com/drupal/core-composer-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 drupal/core-dev --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 Composer Scaffold](https://github.com/drupal/core-composer-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 to patch"
        }
    }
}
```

### How can I add js/css libraries using composer.json?

[](#how-can-i-add-jscss-libraries-using-composerjson)

It is possible to install JavaScript libraries with Composer using custom packages as this project does. We previously relied on asset-packagist to do this but had to change our approach after the repository went defunct. Refer to [this tutorial](https://ryanszrama.com/blog/04-18-2022/replace-asset-packagist-custom-package-repositories) for more information.

### How do I specify a PHP version?

[](#how-do-i-specify-a-php-version)

This project supports PHP 8.1 as minimum version (see [Environment requirements of Drupal 10](https://www.drupal.org/docs/system-requirements/php-requirements)), however it's possible that a `composer update` will upgrade some package that will then require PHP 8.1+.

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": "8.1.13"
    }
},
```

###  Health Score

34

—

LowBetter than 75% of packages

Maintenance18

Infrequent updates — may be unmaintained

Popularity40

Moderate usage in the ecosystem

Community24

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 62.9% 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 ~295 days

Total

3

Last Release

948d ago

Major Versions

8.x-dev → 10.x-dev2023-11-29

PHP version history (3 changes)9.x-devPHP >=7.3

8.x-devPHP >=7.1

10.x-devPHP >=8.1.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/621c34dbc1ad3ea00e09f6006aa9607d0046bf862182d59c66f1f18cb51c0f15?d=identicon)[bojanz](/maintainers/bojanz)

![](https://www.gravatar.com/avatar/86a6bdd58eca36ebbb80ea79ca7ab3e6d870377453a3a7a867c85cd929e1492f?d=identicon)[jsacksick](/maintainers/jsacksick)

---

Top Contributors

[![bojanz](https://avatars.githubusercontent.com/u/330162?v=4)](https://github.com/bojanz "bojanz (44 commits)")[![jsacksick](https://avatars.githubusercontent.com/u/1007558?v=4)](https://github.com/jsacksick "jsacksick (9 commits)")[![mglaman](https://avatars.githubusercontent.com/u/3698644?v=4)](https://github.com/mglaman "mglaman (6 commits)")[![rszrama](https://avatars.githubusercontent.com/u/17675?v=4)](https://github.com/rszrama "rszrama (3 commits)")[![drugan](https://avatars.githubusercontent.com/u/3609840?v=4)](https://github.com/drugan "drugan (2 commits)")[![zaporylie](https://avatars.githubusercontent.com/u/1690685?v=4)](https://github.com/zaporylie "zaporylie (2 commits)")[![Kazanir](https://avatars.githubusercontent.com/u/4731136?v=4)](https://github.com/Kazanir "Kazanir (1 commits)")[![haringsrob](https://avatars.githubusercontent.com/u/866743?v=4)](https://github.com/haringsrob "haringsrob (1 commits)")[![webflo](https://avatars.githubusercontent.com/u/123946?v=4)](https://github.com/webflo "webflo (1 commits)")[![weitzman](https://avatars.githubusercontent.com/u/7740?v=4)](https://github.com/weitzman "weitzman (1 commits)")

### Embed Badge

![Health badge](/badges/drupalcommerce-project-base/health.svg)

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

###  Alternatives

[govcms/govcms

GovCMS Drupal Distribution

198102.2k3](/packages/govcms-govcms)[az-digital/az_quickstart

Arizona Quickstart

52280.4k3](/packages/az-digital-az-quickstart)[drupal/recommended-project

Project template for Drupal projects with a relocated document root

1502.8M1](/packages/drupal-recommended-project)[fourkitchens/sous-drupal-project

Starter project for Sous a Drupal distribution featuring a theme based on Emulsify Design System.

141.1k](/packages/fourkitchens-sous-drupal-project)[goalgorilla/open_social

Open Social is a distribution for building social communities and intranets.

194463.2k](/packages/goalgorilla-open-social)[thunder/thunder-distribution

The thunder distribution

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

PHPackages © 2026

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