PHPackages                             sproutcms/module - 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. sproutcms/module

ActiveLibrary[Framework](/categories/framework)

sproutcms/module
================

Template Sprout 4 Module

v4.4.0(5mo ago)01111GPL-2.0-or-laterPHP

Since Apr 5Pushed 5mo ago3 watchersCompare

[ Source](https://github.com/Karmabunny/sprout-module)[ Packagist](https://packagist.org/packages/sproutcms/module)[ RSS](/packages/sproutcms-module/feed)WikiDiscussions master Synced 1w ago

READMEChangelogDependencies (8)Versions (6)Used By (1)

SproutCMS 4 Module Template
===========================

[](#sproutcms-4-module-template)

[SproutCMS](github.com/karmabunny/sprout3) is a flexible and feature rich cms and application framework, developed in PHP, designed to enable quick and agile custom development. SproutCMS was built to reward innovation and encourage developers to produce complex applications. It is built by developers, for developers.

This a *module template* project for Sprout 4. It provides a sample module as a Composer package to be loaded into your Sprout project.

Demo
----

[](#demo)

This module is actually functional and serves as the Demo module for the [sproutcms/site](//github.com/karmabunny/sprout3-site) project.

Install it and see for yourself:

```
composer create-project sproutcms/site
composer serve
```

Getting started
---------------

[](#getting-started)

```
composer create-project sproutcms/module my-module
```

Now update the `composer.json` file:

1. Update the package name
2. Update (or remove) description + keywords
3. Update the license (optional)
4. Update the namespace (also in each php file)
5. Update the package name (and in `DemoModule::getVersion()`)

### Usage

[](#usage)

Install this into your project by publishing the package or with a local or VCS repository:

```
{
    "repositories": [{
        "type": "vcs",
        "url": "https://github.com/user/my-module"
    }]
}
```

### Patch Locals

[](#patch-locals)

This tool will symlink sibling folders as package into a project. This is great for fast development across multiple packages. The config lives inside the composer file `extra.locals`.

### Multiple Modules

[](#multiple-modules)

It's possible to house more than one Sprout module in the same Composer package. One can configure multiple namespaces or simply create multiple module classes.

###  Health Score

37

—

LowBetter than 81% of packages

Maintenance72

Regular maintenance activity

Popularity10

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity46

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~177 days

Total

5

Last Release

157d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/11b33084210490439a6fb2c0b277e0bf39f8d0e368f20bebb703834003a617df?d=identicon)[karmabunny](/maintainers/karmabunny)

---

Top Contributors

[![gwillz](https://avatars.githubusercontent.com/u/3466850?v=4)](https://github.com/gwillz "gwillz (23 commits)")

---

Tags

frameworkmysqlcmsContent management systemsprout

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/sproutcms-module/health.svg)

```
[![Health](https://phpackages.com/badges/sproutcms-module/health.svg)](https://phpackages.com/packages/sproutcms-module)
```

###  Alternatives

[sproutcms/cms

Enterprise content management and framework

243.0k4](/packages/sproutcms-cms)[impresscms/impresscms

ImpressCMS is an open source content management system with a focus on security and speed

311.1k](/packages/impresscms-impresscms)

PHPackages © 2026

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