eea-storybook

Introduction

This is the Volto project used to build Storybook for EEA Design System

EEA Volto Frontend

If you need to bootstrap a new Volto Frontend project for a new EEA Website, see volto-frontend-template

EEA Volto Add-on

If you need to bootstrap a new Volto Add-on for your EEA Website project, see volto-addon-template

Volto training

A training on how to create your own website using Volto is available as part of the Plone training at https://training.plone.org/.

Volto documentation

Volto documentation is available at 6.docs.plone.org

Getting started

1. Install nvm

   touch ~/.bash_profile
   curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash
   
   source ~/.bash_profile
   nvm version
   

2. Install latest NodeJS LTS 16.x:

   nvm install 16
   nvm use 16
   node -v
   v16.13.1
   

3. Install yarn

   curl -o- -L https://yarnpkg.com/install.sh | bash
   yarn -v
   

4. Clone:

   git clone https://github.com/eea/eea-storybook.git
   cd eea-storybook
   

5. Install the project packages

   yarn

6. Build resources if you run frontend in production mode

   yarn build
   

7. Start backend and check logs for application ready message

    docker-compose up -d backend
    docker-compose logs -f backend
   

   A new data folder will be created which will be mounted as a docker volume.

   Inside it, you will find the Plone database, the site changes are persisted inside it.

8. Start frontend in develop mode without the need to build the JS resources

   yarn start
   

9. Or start frontend in production mode

    yarn start:prod
   

10. See application at http://localhost:3000

11. Login with admin:admin

Try it without developing

1. Install Docker

2. Install Docker Compose

3. Start the Plone backend and the Volto frontend:

   git clone https://github.com/eea/eea-storybook.git
   cd eea-storybook
   
   docker-compose pull
   docker-compose up -d
   

   optionally change PORTS via .env:

   FRONTEND=9000 BACKEND=9100 docker-compose up -d
   

4. See application at http://localhost:4000

Production

We use Docker, Rancher and Jenkins to deploy this application in production.

Release

• Create a new release of this code via git tag command or Draft new release on Github.
  • A new Docker image is built and released automatically on DockerHub based on this tag.

Upgrade

• Within your Rancher environment click on the Upgrade available yellow button next to your stack.

• Confirm the upgrade

• Or roll-back if something went wrong and abort the upgrade procedure.