Tema di Plone per la Pubblica Amministrazione

io-Comune è il tema Volto per il CMS Plone che rispetta le indicazioni Linee guida di design per i servizi digitali della PA usando bootstrap-italia.

E' basato sulle linee guida versione 2020.1 e questo tema estende il tema base di Volto design.plone.theme.

io-Comune non è solo un tema grafico ma gestisce e implementa anche tutte le tipologia di contenuto (Content Type) delle linee guida: di fatto consente la realizzazione di un sito istituzionale di un Comune (ma anche di altri tipi di Enti) conforme alle linee guida di design.

Il sistema implementa anche un tipo di contenuto ad hoc per la gestione di sottositi, in linee con le indicazioni generali.

Si veda ad esempio: Comune di Modena: Informagiovani

Esempi di siti che usano questo tema/sistema:

• ASP Comuni Modenesi Area Nord
• Azienda Ospedaliero-Universitaria di Ferrara
• Azienda USL di Ferrara
• Biblioteche Pianura Est
• Camera di Commercio dell'Umbria
• Camera di Commercio di Reggio Emilia
• Comune di Bibbiano
• Comune di Camposanto
• Comune di Cantagallo
• Comune di Imola
• Comune di Medolla
• Comune di Mirandola
• Comune di Modena
• Comune di Montecchio Emilia
• Comune di Parma
• Comune di Piacenza
• Comune di Reggio Emilia
• Comune di San Lazzaro di Savena
• Comune di San Polo d'Enza
• Comune di San Possidonio
• Comune di Santilario d'Enza
• Comune di Vaiano
• Comune di Vernio
• Comando Generale della Guardia di Finanza
• NNB Ispra Ambiente
• Nuovo Circondario Imolese
• Ospedali Galliera - Bilancio Sociale
• Provincia di Pisa
• UCMAN (Unione dei Comuni Modenesi Area Nord)
• Unione Val d'Enza
• Unione Val di Bisenzio

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.

Quick Start

Below is a list of commands you will probably find useful.

yarn install

Installs dependencies with yarn. If you aren't installing new dependencies (after updating the package.json file), you may want to use yarn install --frozen-lockfile instead to be sure the versions are the correct ones.

Otherwise, you can use yarn install-full to have a fresh istallation.

yarn start

Runs the project in development mode. You can view your application at http://localhost:3000

The page will reload if you make edits.

yarn build

Builds the app for production to the build folder.

The build is minified and the filenames include the hashes. Your app is ready to be deployed!

yarn start:prod

Runs the compiled app in production.

You can again view your application at http://localhost:3000

yarn test

Runs the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.

yarn i18n

Runs the test i18n runner which extracts all the translation strings and generates the needed files.

mrs_developer

mrs_developer is a great tool for developing multiple packages at the same time.

yarn develop

or

yarn develop:npx

(if you haven't installed mrs-developer yet)

Volto's latest razzle config will pay attention to your jsconfig.json file for any customizations.

Release

It's all configured for release-it and uses conventional changelog (see COMMITLINT.md). To run a release, just run:

yarn release-it

if you want to check the configuration, it's in .release-it.json.

By default it will use the commits type and scope to determine the version following semamtic versioning rules, but if you want to set a different version, you can add to the release command the version step: major, minor or step. For example:

yarn release-it -- major

Deploy and prodution scripts

We have some scripts for that!

Our usual scripts are yarn deploy:prod or yarn deploy:staging.

These commands will build and restart a classical pm2 installation and this is an example of how they are configured:

{
  "build:staging": "RAZZLE_PUBLIC_URL=https://staging.my.domain.it RAZZLE_API_PATH=https://staging.my.domain.it/api PORT=4000 razzle build",
  "build:prod": "RAZZLE_PUBLIC_URL=https://www.my.domain.it RAZZLE_API_PATH=https://www.my.domain.it/api RAZZLE_INTERNAL_API_PATH=http://127.0.0.1:8080/Plone PORT=4000 razzle build",
  "deploy:staging": "rm -rfd node_modules/ && yarn cache clean && yarn install --frozen-lockfile && yarn build:staging && pm2 restart myproject-volto",
  "deploy:prod": "rm -rfd node_modules/ && yarn cache clean && yarn install --frozen-lockfile && yarn build:prod && pm2 delete myproject-volto && pm2 start ecosystem.config.js"
}

If in a production environment, it may have two installations, to always have a running instance of the app while the other can be prepared for a new deployment, minimizing the downtime. That's why we have pm2 delete myproject-volto && pm2 start ecosystem.config.js and not pm2 restart myproject-volto: the former is meant to be run in the installation that's not runnng.

Update "child" themes

In order to update a "child" project, we have this handy script: update-dvt.