Volto Starter Kit (EEA Volto Add-ons)

DEPRECATED: Use official @plone/create-volto-app

This is both a Github template repository that will allow you to easily boostrap a new Volto Frontend project and also a developmnet environment for existing and new EEA Volto Add-ons

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.

Development

1. Clone:

    $ git clone https://github.com/eea/volto-starter-kit.git
    $ cd volto-starter-kit
   

2. Install nvm

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

3. Install latest NodeJS 10.x:

    $ nvm install 10
    $ nvm use 10
    $ node -v
    v10.19.0
   

4. Install yarn

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

5. Install and run mrs-develop

    $ npm -g i mrs-developer
    $ missdev
   

6. Install

    $ npm install
   

7. Activate develop add-ons

    $ yarn develop
    $ yarn activate:all
    $ yarn prebuild
   

8. Start and setup backend

     $ yarn start:backend
   

   • Go to http://localhost:8080 Advanced:
   • Add Plone site with add-ons enabled (user: admin, password: admin):
     • eea.restapi
     • kitconcept.voltodemo

9. Start frontend

    $ yarn start
   

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

11. Change existing Volto add-ons or create new ones within:

     $ cd src/develop/
     $ ls -l
    

Try it

1. Install Docker

2. Install Docker Compose

3. Start:

    $ git clone https://github.com/eea/volto-starter-kit.git my-volto-app
    $ cd my-volto-app
   
    $ docker-compose pull
    $ docker-compose up -d
   

   optionally change PORTS via .env:

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

4. Go to http://localhost:8080 Advanced:

   • Add Plone site with add-ons enabled (user: admin, password: admin):
     • eea.restapi
     • kitconcept.voltodemo

5. See application at http://localhost:8000

Boostrap new EEA Volto Frontend project

• Github > eea/volto-starter-kit click on Use this template

Synchronize your EEA Volto Frontend project

Synchronize git templates generated by GitHub as if they were forks.

In order to synchronize a child instance of Github eea/volto-starter-kit template template you can run:

    $ yarn sync

Production

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

Deploy

• Within Rancher > Catalog > EEA deploy Volto

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.
  • A new entry is automatically added to Volto EEA Rancher Catalog

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.