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

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:

  "addons": [
      "@eeacms/volto-eea-design-system"
  ],
  
  "dependencies": {
      "@eeacms/volto-eea-design-system": "*"
  }

• If not, create one:

  npm install -g yo @plone/generator-volto
  yo @plone/volto my-volto-project --canary --addon @eeacms/volto-eea-design-system
  cd my-volto-project

1. Install new add-ons and restart Volto:

   yarn
   yarn start

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)