Skip to content

eea/marine-frontend

Repository files navigation

WISE Marine: Volto Frontend

Release Pipeline Pipeline Release pipeline

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

    nvm install 12
    nvm use 12
    node -v
    v12.16.2
    
  3. Install yarn

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

    $ git clone https://github.com/eea/marine-frontend.git
    $ cd marine-frontend
    
  5. Activate develop add-ons

    $ yarn develop
    
  6. Install dependencies using Yarn

    $ yarn
    
  7. Start frontend in develop mode without the need to build the JS resources

    $ yarn start
    
  8. Or start frontend in production mode

    $ yarn start:prod
    
  9. See application at http://localhost:3000

Backend

Installation:

Plone 5 backend package for the WISE-Marine website: https://github.com/eea/marine-backend

  1. Install Docker

  2. Install Docker Compose

  3. Clone (in marine-frontend package)

    $ cd marine-frontend
    $ git clone git@github.com:eea/marine-backend.git backend
    
  4. Build and run the image

    $ docker-compose build
    $ docker-compose up -d
    

Start the stack:

  $ docker-compose up -d backend

Use the shell container to start Plone:

  $ docker-compose exec backend bash

Inside the Plone container, you can use the instance script to start Zope:

  $ bin/standalone fg

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

Production

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

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.