SilverStripe WebPack boilerplate + Basics of JS/CSS UI
Go to file
2018-04-21 10:51:00 +07:00
public SS4.1 support 2018-03-24 17:45:31 +07:00
site [FIX] Icons path 2018-04-21 10:51:00 +07:00
.editorconfig [IMPROVEMENT] eslint configuration 2018-02-09 19:10:40 +07:00
.env.dist SS4.1 support 2018-03-24 17:45:31 +07:00
.eslintignore SS4.1 support 2018-03-24 17:45:31 +07:00
.eslintrc API: automatic linting of JS and SCSS 2018-02-22 18:48:28 +07:00
.gitignore Minor updates 2018-04-21 10:36:06 +07:00
browserconfig.xml SS4.1 support 2018-03-24 17:45:31 +07:00
cache.appcache SS4.1 support 2018-03-24 17:45:31 +07:00
composer.json Minor updates 2018-04-21 10:36:06 +07:00
humans.txt Intial commit 2018-02-05 18:11:01 +07:00
LICENSE.md LICENSE.md 2018-02-06 10:52:55 +07:00
manifest.json SS4.1 support 2018-03-24 17:45:31 +07:00
package-lock.json Minor updates 2018-04-21 10:36:06 +07:00
package.json Minor updates 2018-04-21 10:36:06 +07:00
phpunit.xml Intial commit 2018-02-05 18:11:01 +07:00
README.md [FIX] Readme 2018-03-24 17:50:48 +07:00
robots.txt Intial commit 2018-02-05 18:11:01 +07:00
webpack.config.common.js Minor updates 2018-04-21 10:36:06 +07:00
webpack.config.dev.js Minor updates 2018-04-21 10:36:06 +07:00
webpack.config.prod.js Minor updates 2018-04-21 10:36:06 +07:00
webpack.configuration.js Deferred Requirements support 2018-02-22 20:39:58 +07:00

silverstripe-webpack SS4.1.*

Simple WebPack boiler plate for SilverStripe

Checkout files at /site/ folder for details

Features:

  • You can use /site/_config/webpack.yml to setup webpack server parameters which will be used by webpack server and by SilverStripe to serve static content
  • You can use WebpackJS('file-name') and WebpackCSS('file-name') functions at templates to require JS and CSS. It will be served using static files or by using Webpack if the website in development mode and Webpack server is running
  • WebpackTemplateProvider::WebpackJS('file-name') and WebpackTemplateProvider::WebpackCSS('file-name') can be used at php area
  • All images will be optimised at /site/src/img and will be written to /site/client/img (by default)
  • Favicons will be generated at /site/client/icons using /site/src/favicon.png
  • Folder /site/src/js/types is used to create page specific JS (just create JS file there and it will be compiled)
  • Folder /site/src/scss/types is used to create page specific CSS (just create SCSS file there and it will be compiled)
  • Automatic linting (JS+SCSS)
  • Bootstrap 4 included by default
  • Font-Awesome included by default
  • Deferred requirements loading
  • Requirements auto-loading

Folder structure:

  • /site/_config/webpack.yml (Webpack configurtion)

  • /site/code/WebpackTemplateProvider.php (WebpackJS and WebpackCSS functionality)

  • /site/code/DeferedRequirements.php (Deferred Requirements + Requirements auto-loader)

  • /site/templates/Page.ss (An example Page.ss)

  • /site/src (Your sources)

  • /site/client (Your production assets)

  • /site/src/js (Your JS-scripts)

  • /site/src/js/_components (Your JS components to be included)

  • /site/src/js/_components/_spinner.js (An example to display and hide loading spinner)

  • /site/src/js/app.js (main application file to include website-wide components)

  • /site/src/js/main.js (Your custom site-wide functionality)

  • /site/src/js/_events.js (Your custom site-wide events)

  • /site/src/js/_pageType_and_component_template.js (A template which can be used to create new modules)

  • /site/src/types/*.js (Extra page-specific modules to be auto-compiled. My suggestion is to use ClassName.js and then require it at SilverStripe custom controller area)

  • /site/src/scss (Your styling to be compiled)

  • /site/src/scss/_components (Your custom SCSS components)

  • /site/src/scss/app.scss (main application file to include site-wide components)

  • /site/src/scss/_variables.sccs (your custom variables, ex. bootstrap)

  • /site/src/scss/_layout.sccs (Your site-wide styling)

Requirements:

  • composer
  • yarn

Instalation:

Commands:

  • yarn - to update packages
  • yarn start - to start webpack development webserver
  • yarn build - to build production assets
  • yarn lint:check - to check SCSS and JS linting
  • yarn lint:fix - to fix SCSS and JS linting automatically

TODO: