A Boilerplate is a convenient way to define components to be used by a project, so that new projects can be created quickly with the same tooling set up as soon as the project is created.
A Boilerplate can be used to define any project-level components and processes that are to be re-used (note that Python components will be handled by our addon system and Pip, not by Boilerplates) but will typically take care of a project’s frontend set-up.
When a project is created, it will always specify a Boilerplate - even if it’s a pre-defined Blank Boilerplate that leaves all these choices up to you.
Various Boilerplates are provided as defaults. Some provide only basic HTML and CSS, whereas more sophisticated ones include advanced frontend tooling: NPM, webpack, Sass and other components. It it’s also possible to define and reuse your own.
Our built-in Boilerplates¶
This list represents some key built-in Boilerplates, but others are added regularly.
The Blank Boilerplate installs no components. It will be up to you to install anything you need, including templates for your site.
Our implementation of it is very standard, and simply adapts it for use in django CMS projects.
Bootstrap and Foundation Boilerplates¶
Our Sass Boilerplate introduces compiled components. This is a dynamic Boilerplate, unlike those above, which is to say that it compiles its own materials at runtime (the static Boilerplates by contrast simply use or serve the materials they ship with).
The Sass Boilerplate uses the HTML5 Boilerplate package as its basis. It uses:
The advantage of using a dynamic Boilerplate with compiled components is that it permits you to build a customised frontend, shorn of items your project does not require. Compiled components can also be heavily compressed and optimised, while the source files you work on can remain readable and comprehensive.
How Boilerplates work¶
When you create a new project via the Divio Control Panel, you select a Boilerplate at the same time.
The Control Panel examines the Boilerplate to determine what components should then be installed.
It does this by checking:
boilerplate.jsonfile (required in all Boilerplates). If templates are specified here, they will be applied to the django CMS configuration as available templates.
Dockerfile. Sections in the
Dockerfilewill be copied to the project’s
Dockerfileappropriately; for example:
# <NODE> ADD build /stack/boilerplate ENV NODE_VERSION=6.10.1 \ NPM_VERSION=3.10.10 RUN bash /stack/boilerplate/install.sh ENV NODE_PATH=$NVM_DIR/versions/node/v$NODE_VERSION/lib/node_modules \ PATH=$NVM_DIR/versions/node/v$NODE_VERSION/bin:$PATH # </NODE>
will be copied to the:
# <NODE> # </NODE>
The Control Panel will then copy all files (other than the two mentioned above)
and directories in the Boilerplate into the project, unless they are explicitly
excluded in the the
The Control Panel will also detect and respond automatically to the presence of various other files in the Boilerplate. These files are:
package.json- will be used by
npmto install node packages
.bowerrc- will be used by Bower to install frontend components. Note that this is provided as legacy support. We no longer recommend Bower (use npm instead)
gulpfile.js- used by Gulp execute specified compilation tasks
The Control Panel will write appropriate commands into the Dockerfile, so that when the project is next deployed, the appropriate components will be installed and tasks run.
Bower commands will be placed inside the
# <BOWER>/# </BOWER> section of
the Dockerfile, and so on.
These operations are performed by the Control Panel only. They will not be performed in the local environment, but only on the Test and Live servers.
If you make changes to these files locally, in order to see the effect you will need to:
- push your changes to the Cloud, where they will be processed into the Dockerfile
- pull down the project again