gdmedia / silverstripe-module-boilerplate
Simple boilerplate to help kick start a new Silverstripe module.
Installs: 14
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 6
Forks: 1
Open Issues: 1
Language:JavaScript
Type:silverstripe-module
Requires
- php: >=5.3.2
- silverstripe/cms: ^3.1
- silverstripe/framework: ^3.1
This package is not auto-updated.
Last update: 2022-06-22 13:26:49 UTC
README
Simple boilerplate to help kick start a new Silverstripe 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
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
and update the values to suit your new module. - Edit
Gruntfile.js
-lines 5 to 9
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
andGruntfile.js
-lines 5 to 9
- Update
composer.json
andbower.json
from the corresponding values inpackage.json
- Rename the following files, replacing
MyModule
with the value ofprefix
inGruntfile.js
###grunt update_json
Running grunt update_json
will update composer.json
and bower.json
from the corresponding values in package.json
###grunt jshint
Running grunt jshint
will run js hint over all non-minified javascript files in assets/javascript
###grunt uglify
Running grunt uglify
will run minify javascript files in assets/javascript
###grunt cssmin
Running grunt cssmin
will run minify CSS files in assets/css
###grunt default
Running grunt default
will run the update_json
, jshint
, uglify
and cssmin
tasks one after another.
Pull requests welcome!
If you have a class, file or anything else that may be handy to have in this boilerplate, submit an issue or pull request