eeavolto-eea-design-system
Volto EEA Design System
Features
This package provides the following features:
- A Semantic UI theme
- A repository for the design system source files and mockups
- 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
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 startGo to http://localhost:3000
Add volto-eea-design-system to your Volto project
Make sure you have a Plone backend up-and-running at http://localhost:8080/Plone
docker compose up backendStart 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-projectInstall new add-ons and restart Volto:
yarn yarn startGo to http://localhost:3000
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.