shatodj/bolt-shato-theme

The boilerplate theme for Bolt 4 CMS, built with Webpack

1.0.0 2021-07-30 08:29 UTC

Requires

• twig/twig: ^2.0

Conflicts

• bolt/bolt: < 3.999

MIT

• theme
• bolt
• webpack
• bulma

README

The boilerplate theme for Bolt 5 CMS.

The theme is designed to provide an easy way to extend core elements in the template. Custom content types in theme enhance user experience to put custom reusable Section Blocks.

Features

• Customize colors appearance
• Extends themes blocks using twig
• Lazy loading for images and section backgrounds
• Responsive design
• dev and production build
• NO JQUERY as you don't need it!
• EcmaScript6 syntax

Techstack

• Webpack 5
  • compile+minify scss from /src/scss to /dist/css
  • compile+uglify js from /src/js to /dist/js
  • optimizing images from /src/images to /dist/images
  • exporting fonts from /src/fonts to /dist/fonts
  • exporting google fonts to /dist/css/woff.css
• Bulma.io
• Font Awesome
• FsLightbox
• eslint

How to run on your develeper machine

Requirements

• Node.js v20 and above

Step by step

1. GIT Clone this project to Bolt's theme directory OR use composer install:

   composer require shatodj/bolt-shato-theme
   
   bin/console bolt:copy-theme shatodj/bolt-shato-theme
   

2. Install Bolt dependencies

   composer require bolt/forms
   composer require appolodev/bolt-seo
   
   

3. Install project dependencies in the theme's directory:

   cd <bolt_directory>/public/theme/bolt-shato-theme
   npm install 
   

4. Run prepare script, that will:

   • generate environment variables and config files needed for build
   • add theme's custom Content Types and Taxonomies to Bolt's config files (make sure script will have permissions to write)

   npm run prepare
   

5. Build theme

   # build for development
   npm run build:dev
   
   # ..or build for production
   npm run build
   

6. Don't forget to change the default theme property in Bolt's config/bolt/config.yaml

   theme: bolt-shato-theme
   

7. Regenerate database fixtures (Optional). With the previous step we created some new content types. This will purge the current database and create new with dummy data.

   cd ../../../
   bin/console doctrine:fixtures:load
   
   

TODO:

• Get rid of JQuery
• Maintenance template twig fix
• deploy/archive script
• Progressive images loading (Currently possible only for section backgrounds)
• Live reload for updating js/scss
• Fill demo content script by the theme preference
• Section Blocks docu