volto-eea-design-system

Volto EEA Design System

Features

This package provides the following features:

1. A Semantic UI theme
2. A repository for the design system source files and mockups
3. A website to showcase the design system

Try the design system website

Checkout the docs found within the website folder

Try the design system mockups

Checkout the docs found within the mockups folder from the figma_mockups branch.

Note

We moved the mockups to a separate branch to avoid bloating the main branch with large files.

Docusaurus and Storybook

See Docusaurus. See Storybook.

Getting started

Try volto-eea-design-system with Docker

  git clone https://github.com/eea/volto-eea-design-system.git
  cd volto-eea-design-system
  make
  make start

Go to http://localhost:3000

make start now defaults to Volto 18. To run the same setup against Volto 17, use:

  VOLTO_VERSION=17 make
  VOLTO_VERSION=17 make start

Add volto-eea-design-system to your Volto project

1. Make sure you have a Plone backend up-and-running at http://localhost:8080/Plone

   docker compose up backend

2. Start Volto frontend

• If you already have a volto project, just update package.json:

  "dependencies": {
      "@eeacms/volto-eea-design-system": "*"
  }

  and volto.config.js:

  const addons = ['@eeacms/volto-eea-design-system'];

• If not, create one with Cookieplone, as recommended by the official Plone documentation for Volto 18+:

  uvx cookieplone project
  cd project-title
  

1. Install or update dependencies, then start the project:

   make install
   

   For a Cookieplone project, start the backend and frontend in separate terminals:

   make backend-start
   make frontend-start
   

   For a legacy Volto 17 project, install the package with yarn and restart the frontend as usual.

2. Go to http://localhost:3000

3. Happy editing!

Release

See RELEASE.md.

How to contribute

See DEVELOP.md.

Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.

See LICENSE.md for details.

Funding

European Environment Agency (EU)