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

ActiveSilverstripe-vendormodule[Framework](/categories/framework)

robbieaverill/silverstripe-module
=================================

A skeleton for SilverStripe modules.

2.x-dev(7y ago)014BSD-3-ClauseJavaScript

Since Nov 22Pushed 7y ago1 watchersCompare

[ Source](https://github.com/robbieaverill/silverstripe-module)[ Packagist](https://packagist.org/packages/robbieaverill/silverstripe-module)[ RSS](/packages/robbieaverill-silverstripe-module/feed)WikiDiscussions 2 Synced 2d ago

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

SilverStripe supported module skeleton
======================================

[](#silverstripe-supported-module-skeleton)

A useful skeleton to more easily create modules that conform to the [Module Standard](https://docs.silverstripe.org/en/developer_guides/extending/modules/#module-standard).

This readme contains descriptions of the parts of this module base you should customise to meet you own module needs. For example, the module name in the H1 above should be you own module name, and the description text you are reading now is where you should provide a good short explanation of what your module does.

Where possible we have included default text that can be included as is into your module and indicated in other places where you need to customise it

Below is a template of the sections of your readme.md you should ideally include to met the Module Standard and help others make use of your modules.

**Please note:** This module is designed to be a "vendor module". If you need to use it as a non-vendor module, you will need to adjust the import paths for silverstripe/admin JS and SCSS loaders.

Requirements
------------

[](#requirements)

- SilverStripe ^4.0
- [Yarn](https://yarnpkg.com/lang/en/), [NodeJS](https://nodejs.org/en/) and [npm](https://npmjs.com) (for building frontend assets)
- Other module
- Other server requirement
- Etc

Installation
------------

[](#installation)

Add some installation instructions here, having a 1 line composer copy and paste is useful. Here is a composer command to create a new module project. Ensure you read the ['publishing a module'](https://docs.silverstripe.org/en/developer_guides/extending/how_tos/publish_a_module/) guide and update your module's composer.json to designate your code as a SilverStripe module.

```
composer require robbieaverill/silverstripe-module 2.x-dev

```

**Note:** When you have completed your module, submit it to Packagist or add it as a VCS repository to your project's composer.json, pointing to the private repository URL.

License
-------

[](#license)

See [License](license.md)

We have included a 3-clause BSD license you can use as a default. We advocate for the BSD license as it is one of the most permissive and open licenses.

Feel free to alter the [license.md](license.md) to suit if you wan tto use an alternative license. You can use [choosealicense.com](http://choosealicense.com) to help pick a suitable license for your project.

Documentation
-------------

[](#documentation)

- [Documentation readme](docs/en/readme.md)

Add links into your docs/ folder here unless your module only requires minimal documentation in that case, add here and remove the docs folder. You might use this as a quick table of content if you mhave multiple documentation pages.

Example configuration (optional)
--------------------------------

[](#example-configuration-optional)

If your module makes use of the config API in SilverStripe it's a good idea to provide an example config here that will get the module working out of the box and expose the user to the possible configuration options.

Provide a yaml code example where possible.

```
Page:
  config_option: true
  another_config:
    - item1
    - item2

```

Maintainers
-----------

[](#maintainers)

- Person here
- Another maintainer

Bugtracker
----------

[](#bugtracker)

Bugs are tracked in the issues section of this repository. Before submitting an issue please read over existing issues to ensure yours is unique.

If the issue does look like a new bug:

- Create a new issue
- Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots and screencasts can help here.
- Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, Operating System, any installed SilverStripe modules.

Please report security issues to the module maintainers directly. Please don't file security issues in the bugtracker.

Development and contribution
----------------------------

[](#development-and-contribution)

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

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

Unknown

Total

1

Last Release

2730d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/04057079b9a8a168a9e8c40cf7bac17f05047255c48b71b63fc610db06f096cb?d=identicon)[robbieaverill](/maintainers/robbieaverill)

---

Tags

silverstripecms

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

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

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

###  Alternatives

[silverstripe/cms

The SilverStripe Content Management System

5163.4M1.3k](/packages/silverstripe-cms)[dnadesign/silverstripe-elemental

Elemental pagetype and collection of Elements

1151.0M255](/packages/dnadesign-silverstripe-elemental)[silverstripe-module/skeleton

A skeleton for Silverstripe CMS modules.

281.2k](/packages/silverstripe-module-skeleton)[symbiote/silverstripe-multisites

Allows for multiple websites to be managed through a single site tree.

1313.7k4](/packages/symbiote-silverstripe-multisites)[symbiote/silverstripe-steamedclams

139.5k](/packages/symbiote-silverstripe-steamedclams)

PHPackages © 2026

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