PHPackages gdmedia/silverstripe-module-boilerplate - 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. gdmedia/silverstripe-module-boilerplate AbandonedArchivedSilverstripe-module gdmedia/silverstripe-module-boilerplate ======================================= Simple boilerplate to help kick start a new Silverstripe module. 1141[1 PRs](https://github.com/guru-digital/silverstripe-module-boilerplate/pulls)JavaScript Since Feb 17Pushed 10y ago3 watchersCompare [ Source](https://github.com/guru-digital/silverstripe-module-boilerplate)[ Packagist](https://packagist.org/packages/gdmedia/silverstripe-module-boilerplate)[ RSS](/packages/gdmedia-silverstripe-module-boilerplate/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) Silverstripe boilerplate module =============================== [](#silverstripe-boilerplate-module) Simple boilerplate to help kick start a new Silverstripe module. Creating a new module --------------------- [](#creating-a-new-module) Quickly setup a new module skeleton by cloning this repository and deleting the .git folder. To do this in one line, from the command line run: (*Replace ***`MyModuleFolder`*** with name of the folder where you want to create your new module.*) \###Windows **Using Composer** ``` cmd /V /C "set "SS_MODULE_DIR=MyModuleFolder" && composer require gdmedia/silverstripe-module-boilerplate && move silverstripe-module-boilerplate !SS_MODULE_DIR! && composer remove gdmedia/silverstripe-module-boilerplate && IF EXIST !SS_MODULE_DIR!\.git rmdir /q /s !SS_MODULE_DIR!\.git" ``` **Using GIT** ``` cmd /V /C "set "SS_MODULE_DIR=MyModuleFolder" && git clone https://github.com/guru-digital/silverstripe-module-boilerplate.git !SS_MODULE_DIR! && rmdir /q /s !SS_MODULE_DIR!\.git" ``` \###\*nix **Using Composer** ``` SS_MODULE_DIR=MyModuleFolder && composer require --prefer-dist gdmedia/silverstripe-module-boilerplate && mv silverstripe-module-boilerplate $SS_MODULE_DIR && composer remove gdmedia/silverstripe-module-boilerplate && [ -d ${SS_MODULE_DIR}/.git ] && rm -r ${SS_MODULE_DIR}/.git ``` **Using GIT** ``` SS_MODULE_DIR=MyModuleFolder && git clone https://github.com/guru-digital/silverstripe-module-boilerplate.git $SS_MODULE_DIR && rm -rf ${SS_MODULE_DIR}/.git ``` Grunt ----- [](#grunt) You can use Grunt to quickly rename the boiler plate file names and place holders. \###grunt rename-project To use, after installing with the steps above: - Edit [`package.json`](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/package.json) and update the values to suit your new module. - Edit [`Gruntfile.js` - `lines 5 to 9`](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/Gruntfile.js#L5-L9) and update the values to suit your new module. - From the command line run: (*Replace ***`MyModuleFolder`*** with name of the folder where you want to create your new module.*) ``` cd MyModuleFolder npm install grunt rename-project ``` This will: - Replace all place holder values in all files with related values from [`package.json`](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/package.json) and [`Gruntfile.js` - `lines 5 to 9`](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/Gruntfile.js#L5-L9) - Update [`composer.json`](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/composer.json) and [`bower.json`](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/bower.json) from the corresponding values in [`package.json`](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/package.json) - Rename the following files, replacing `MyModule` with the value of [`prefix` in `Gruntfile.js`](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/Gruntfile.js#L8) - [assets\\css\\MyModuleCSS.css](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/assets%5Ccss%5CMyModuleCSS.css) - [assets\\images\\sitetree-images\\MyModulePageIcon.png](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/assets%5Cimages%5Csitetree-images%5CMyModulePageIcon.png) - [assets\\javascript\\MyModuleJS.js](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/assets%5Cjavascript%5CMyModuleJS.js) - [code\\Extension\\MyModuleDataExtension.php](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/code%5CExtension%5CMyModuleDataExtension.php) - [code\\Extension\\MyModuleExtension.php](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/code%5CExtension%5CMyModuleExtension.php) - [code\\PageTypes\\MyModulePage.php](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/code%5CPageTypes%5CMyModulePage.php) \###grunt update\_json Running `grunt update_json` will update [`composer.json`](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/composer.json) and [`bower.json`](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/bower.json) from the corresponding values in [`package.json`](https://github.com/guru-digital/silverstripe-module-boilerplate/blob/master/package.json) \###grunt jshint Running `grunt jshint` will run js hint over all non-minified javascript files in [`assets/javascript`](https://github.com/guru-digital/silverstripe-module-boilerplate/tree/master/assets/javascript) \###grunt uglify Running `grunt uglify` will run minify javascript files in [`assets/javascript`](https://github.com/guru-digital/silverstripe-module-boilerplate/tree/master/assets/javascript) \###grunt cssmin Running `grunt cssmin` will run minify CSS files in [`assets/css`](https://github.com/guru-digital/silverstripe-module-boilerplate/tree/master/assets/css) \###grunt default Running `grunt default` will run the `update_json`, `jshint`, `uglify` and `cssmin` tasks one after another. Pull requests welcome! ---------------------- [](#pull-requests-welcome) If you have a class, file or anything else that may be handy to have in this boilerplate, submit an [issue](https://github.com/guru-digital/silverstripe-module-boilerplate/issue) or [pull request](https://github.com/guru-digital/silverstripe-module-boilerplate/pull) ### Health Score 21 — LowBetter than 18% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity8 Limited adoption so far Community11 Small or concentrated contributor base Maturity41 Maturing project, gaining track record Bus Factor1 Top contributor holds 85.7% 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. ### Community Maintainers ![](https://www.gravatar.com/avatar/fd35dd126c29e8d7146e07e3ea10f418792bbcdbee48ead7bb491eb495d6bb4a?d=identicon)[gurudigital](/maintainers/gurudigital) --- Top Contributors [![cjsewell](https://avatars.githubusercontent.com/u/1856199?v=4)](https://github.com/cjsewell "cjsewell (6 commits)")[![gurudigital](https://avatars.githubusercontent.com/u/8206306?v=4)](https://github.com/gurudigital "gurudigital (1 commits)") ### Embed Badge ![Health badge](/badges/gdmedia-silverstripe-module-boilerplate/health.svg) ``` [![Health](https://phpackages.com/badges/gdmedia-silverstripe-module-boilerplate/health.svg)](https://phpackages.com/packages/gdmedia-silverstripe-module-boilerplate) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)