[Deprecated] Umami is now included in Drupal Core. All further work happens there.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
css
images
js/components/navigation/menu-main
templates
.gitignore
LICENSE.txt
README.md
composer.json
logo.svg
umami.breakpoints.yml
umami.info.yml
umami.libraries.yml
umami.theme

README.md

Umami

This is a repository to store source code for the Umami theme, a part of the 'Out of the Box' initiative for Drupal.

Designs

Designs are attached to the summary of #2900720: Designs for the Out of the Box experience intiative and are also available in InVision.

Resources

  • There is a Google Drive folder with shared files (documents, assets etc.).
  • Here is a PDF Styleguide with colors, typography, etc. The latest version can be found in the issue.

Installing

To work on the theme it is also necessary to have the Installation profile and the default content we are on which we are basing our theming.

Installing the Umami Demo and Umami theme:

To install the Umami Demo locally, you can use the Umami Build installer. This installer uses composer to install everything you need to get up and running (presuming you already have a local development environment for Drupal). You can find the installer here: https://github.com/gareth-fivemile/umami-build. This installer provisions Drupal, the Umami Demo installation profile, the sample content and the Umami theme by cloning the projects from Github. So once you have it installed you can start working on the project locally right away.

Here are the steps to install

  • git clone https://github.com/gareth-fivemile/umami-build.git
  • cd umami-build
  • composer instal
  • cd web
  • Install the Umami Demo (change to your email address): drush si demo_umami --account-pass=admin --account-name=admin --account-mail="your-email@example.com"
  • Install the sample content (temporarily a second manual step): drush en demo_umami_content -y To work on the profile find it in /profiles/contrib/demo_umami To work on the theme find it in /themes/contrib/umami

Updating the Umami Demo and Umami theme:

Once you have the Umami Build installer running, you will want to keep it up to date. Follow these steps to update: If you are working on the installation profile, export any config from Drupal that you need to keep since following this process will delete and install a new version of the database If you have uncommitted changes in your local branches for the profile or the theme commit or stash them. You could also be working on local branches other than dev or master, these should not be affected by the update

  • Change directory to the umami-build directory
  • Get the latest changes for umami_build:
  • git pull
  • Update the dependencies: composer install
  • Reinstall the site (change to your email address): drush si demo_umami -y --account-pass=admin --account-name=admin --account-mail="your-email@example.com"
  • Reinstall the sample content (temporarily a manual step):drush en demo_umami_content -y
  • Continue as normal

Communication, discussions and help

  • Most communication happens on Slack in the #out-of-the-box channel. Feel free to join and ask for help.
  • There is a weekly meeting on Mondays 15:00h-16:00h UTC. Notes.