Home

How to use this template

With Github templates

1. Install required tools:

   npm install -g yo @plone/generator-volto ejs
   

2. Create a new repository from volto-frontend-template - make sure the new reposity name ends with -frontend, e.g.: custom-frontend

3. Clone your new repository on your local machine like:

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

4. Bootstrap Volto project

   yo @plone/volto --skip-install --addon @eeacms/volto-eea-kitkat --workspace src/addons/*
   

   • You can also provide --volto 14.0.0-alpha.35 if you want a specific Volto version

5. Run bootstrap

   node bootstrap
   

6. See changes and commit:

   git diff
   git add .
   git commit -m "Initial commit"
   git push
   

7. Install:

   yarn
   

8. Run:

   • Start backend:

     docker pull eeacms/plone-backend
     docker run -it --rm -e SITE=Plone -e PROFILES=eea.kitkat:default -p 8080:8080 eeacms/plone-backend
     

   • Start frontend:

     yarn start
     

   • Go to http://localhost:3000

9. Create branch develop from branch master and add branch protections ( Settings -> Brancher -> Branch protection rules -> Add rule ):

   • develop - no check-boxes need to be checked, this is added to protect the branch from deletion. Optional - check "Allow force pushes"
   • master - mandatory to check this 5 boxes to setup the Automated Releases:

     Require a pull request before merging:
       Require approvals 
       Dismiss stale pull request approvals when new commits are pushed 
     
     Require status checks to pass before merging 
       Require branches to be up to date before merging