EEA KitKat Demo Frontend

Demo Volto Frontend for included add-ons in volto-eea-kitkat bundle.

Documentation

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

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 16.x:

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

3. Install yarn

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

4. Clone:

    git clone https://github.com/eea/demo-kitkat-frontend.git
    cd demo-kitkat-frontend
   

5. Install

    yarn
    yarn build
   

6. Start backend

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

7. Start frontend

    yarn start:prod
   

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

Automated @eeacms dependencies upgrades

All the addon dependencies that are located in the dependencies section of package.json file that belong to @eeacms and have a MAJOR.MINOR.PATCH version are automatically upgraded on the release of a new version of the addon. This upgrade is done directly on the develop branch.

Exceptions from automated upgrades ( see https://docs.npmjs.com/cli/v8/configuring-npm/package-json#dependencies for dependency configuration examples ) :

• All github or local paths
• Any version intervals ( ^version or >version or MAJOR.MINOR.x etc )

Release

See RELEASE.md

Production

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

Deploy

• Within Rancher > Catalog > EEA

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.

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)