eeacms/insitu-frontend repository overview

⁠insitu-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⁠.

⁠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
   

   Copy

2. Install latest NodeJS 16.x:

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

   Copy

3. Install yarn

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

   Copy

4. Clone:

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

   Copy

5. Install

    yarn build
   

   Copy

6. Start backend

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

   Copy

7. Start frontend

    yarn start:prod
   

   Copy

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⁠

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