eea / ims-frontend

IMS: Volto Frontend

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.

Volto Add-ons

1. @eeacms/volto-eea-kitkat
   1. @eeacms/volto-matomo
   2. @eeacms/volto-sentry-rancher-config
   3. @eeacms/volto-banner
   4. @eeacms/volto-corsproxy
   5. @eeacms/volto-depiction
   6. @eeacms/volto-taxonomy
   7. @eeacms/volto-object-widget
   8. @eeacms/volto-widgets-view
   9. @eeacms/volto-widget-toggle
   10. @eeacms/volto-widget-temporal-coverage
   11. @eeacms/volto-widget-geolocation
   12. volto-slate:asDefault
   13. @eeacms/volto-slate-metadata-mentions
   14. @eeacms/volto-slate-footnote
   15. @eeacms/volto-slate-zotero
   16. @eeacms/volto-listing-block
   17. @eeacms/volto-accordion-block
   18. @eeacms/volto-block-toc
   19. @eeacms/volto-block-divider
   20. @eeacms/volto-metadata-block
   21. @eeacms/volto-group-block
   22. @eeacms/volto-columns-block
   23. @eeacms/volto-block-style
   24. @eeacms/volto-resize-helper
   25. @eeacms/volto-tabs-block
   26. @eeacms/volto-block-image-cards
2. @eeacms/volto-block-data-figure
3. @eeacms/volto-editing-progress
4. @eeacms/volto-workflow-progress
5. @eeacms/volto-ims-theme
6. @eeacms/volto-ims-policy
7. @eeacms/volto-middleware-vh

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 Node.js 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/ims-frontend.git
    cd ims-frontend
   

5. Start backend and check logs for application ready message

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

6. Build resources if you run frontend in production mode

    yarn build
   

7. Start frontend in production mode

    yarn start:prod
   

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

    yarn start
   

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

10. Login with admin:admin

Try it using docker images

1. Install Docker

2. Install Docker Compose

3. Start the Plone backend and the Volto frontend:

    git clone https://github.com/eea/ims-frontend.git
    cd ims-frontend
   
    docker-compose pull
    docker-compose -f demo.yml up
   

   optionally change PORTS via .env:

    FRONTEND=9000 BACKEND=9100 docker-compose -f demo.yml up -d
   

4. 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

Production

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

Deploy

• Within Rancher > Catalog > EEA deploy Volto - IMS

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.