droptica/droopler-project

Project template for Droopler with Composer

8.3.3.0 2025-01-17 08:22 UTC

Requires

• composer/installers: ^1.2
• droptica/droopler: 8.3.3.0
• drupal/core-composer-scaffold: ^10.0
• drupal/core-recommended: ^10.0
• drush/drush: ^12.0
• oomphinc/composer-installers-extender: ^2.0
• zaporylie/composer-drupal-optimizations: ^1.1

Requires (Dev)

• drupal/core-dev: ^10.0
• drupal/devel: ^5.0

Conflicts

• drupal/drupal: *

GPL-2.0-or-later

README

About this repository

This repository is for Droopler 3.x. For Droopler 5.x, there's only one repository (without _project), and the newest version is here: https://www.drupal.org/project/droopler/

What is Droopler?

Droopler is a Drupal 10 profile designed to kickstart a new webpage in a few minutes. It's based on the latest frontend technologies, including Bootstrap 4. The maintainer of Droopler is Droptica.

• Official website: droptica.com/droopler
• Tutorials: droptica.com/droopler/tutorials
• Demo: droopler-demo.droptica.com
• Profile repository: github.com/droptica/droopler
• Drupal.org project: drupal.org/project/droopler
• Issue queue: drupal.org/project/issues/droopler

For the latest news please subscribe to our Facebook and Twitter.

What is this Droopler template?

It's a skeleton, a boilerplate for new projects based on Droopler. If you wish to use Droopler - fork (or download) this repository. It contains a minimum set of code to start your new website. Threat it the same as drupal/recommended-project or drupal-composer/drupal-project.

This code includes:

• composer.json with all dependencies required to run Droopler.
• .gitignore adjusted to use GIT with Drupal.
• Boilerplate subtheme with minimal required CSS/SCSS and Javascript. It contains gulpfile.js to speed up development of Drupal's frontend.

How to build the website?

1) Run Composer

$ composer create-project droptica/droopler-project <path> "^8.3.1"
$ cd droopler
$ composer install

2) Run npm

Droopler is using Gulp stack to speed up development of new sites. It compiles SCSS to CSS, enables Autoprefixer to deal with browser compatibility and minimizes all JavaScript files. Install Node v13 and npm on your computer and in the root directory of your project run the following commands:

$ npm install --global gulp-cli
$ cd web/profiles/contrib/droopler/themes/custom/droopler_theme
$ npm install
$ gulp compile
$ cd -
$ cd web/themes/custom/droopler_subtheme
$ npm install
$ gulp compile

3) Run Drupal installation

Go to http://yourserver.local/install.php and follow the steps of configuration.

Using DDEV

1. Install ddev.
2. Run ddev config to configure the project.
3. Run ddev start to start the project.
4. Run ddev composer install to download the project dependencies.
5. If you notice problems with accessing to the repository, run ddev auth ssh to add the keys from your ~/.ssh directory to the web container and run ddev composer install command once again.
6. Run ddev theme to install the theme dependencies and compile assets. By default, production assets are compiled. You can run ddev theme dev to compile assets for development. You can also run ddev theme watch to watch for changes in SCSS and JS and process them on the fly.
7. Go to the URL provided by ddev and finish installing the website. You can also run ddev build-profile to build the Droopler profile from the CLI (you will get a fully featured version, with blog, products and demo content).

How to work with the subtheme?

First run gulp watch in your subtheme's directory (remember to compile droopler_theme first). It will track all the changes in theme source files and compile assets in the fly.

$ cd web/themes/custom/droopler_subtheme
$ gulp watch

There are also other Gulp commands for theme developers, here's the full reference:

• gulp watch - watches for changes in SCSS and JS and proceses them on the fly
• gulp compile - cleans derivative files and compiles all SCSS/JS in the subtheme for DEV environment
• gulp dist - cleans derivative files and compiles all SCSS/JS in the subtheme for PROD environment
• gulp clean - cleans derivative files
• gulp debug - prints Gulp debug information, this comes in handy when something's not working

Using DDEV

There are several comands that help you to work with the subtheme. You can run them from the root directory of your project.

• ddev theme watch - watches for changes in SCSS and JS and processes them on the fly
• ddev theme dev - cleans derivative files and compiles all SCSS/JS in the subtheme for DEV environment
• ddev theme production - cleans derivative files and compiles all SCSS/JS in the subtheme for PROD environment

SCSS structure

• style.scss - combines all SCSS code from base theme and subtheme
• print.scss - combines all SCSS code for printing from base theme and subtheme
• config/ - the most important directory that contains the subtheme configuration - you can add your own config files like _foobar.scss, just refer to them in _all.scss.
• libraries/ - additional files needed by Drupal

You can use any SCSS structure you like. We recommend dividing files into layout/ and components/ directories. Just remember to include your files in style.scss.

SCSS Configuration

Droopler is designed to make your work easier. You don't have to override SCSS or CSS code to make your own adjustments. In most cases it is enough to modify the configuration. Just look into variable definitions in the subtheme's scss/config/_base_theme_overrides.scss file.

// Colours - The Greeks
// -------------------------
// $color-odysseus: white;

// Paragraph d_p_banner
// -------------------------
// $d-p-banner-header-color: $color-odysseus;
// $d-p-banner-subheader-color: $color-odysseus;

To alter this - uncomment the line and change the value. A you can see - there are many levels of variables, see the comments in _base_theme_overrides.scss to get some more information.

When you save this config file, gulp watch will recompile all SCSS with your own config.

Updating Droopler

See the UPDATE.md file from the Droopler profile.

Switching from 8.3.x.x to 3.x.x tags

When using this Droopler 3.x repository, you should now rely on tags in the 3.x.x format (for example, 3.3.x) instead of the old 8.3.x.x tags. More details on how to switch can be found here: https://www.drupal.org/docs/getting-started/drupal-distributions/droopler

How to install Google Fonts?

By default Droopler uses free Lato webfont. If you wish to install your own fonts from Google - put their definitions into droopler_subtheme.libraries.yml like this:

global-styling:
  version: VERSION
  css:
    theme:
      '//fonts.googleapis.com/css?family=Rajdhani:500,600,700|Roboto:400,700&subset=latin-ext': { type: external, minified: true }
      css/style.css: {}

How to install icon fonts?

If you wish to install FontAwesome or Glyphicons from the CDN - just grab their URLs and follow the steps described in previous chapter about Google Fonts. You'll find a FontAwesome example in droopler_subtheme.libraries.yml and droopler_subtheme.info.yml.