design-comuni-plone-theme/DEVELOPMENT.md

Volto Theme for Italia design guidelines

## Documentazione tecnica (in inglese)

A training on how to create your own website using Volto is available as part of the Plone training at [https://training.plone.org/volto/index.html](https://training.plone.org/volto/index.html).

## Quick Start

Below is a list of commands you will probably find useful.
The quickest way to bootstrap development is using docker, so install it beforehand to use these commands.

### `make build-addon`

Build a docker image to use for development and testing.

Needs to be rebuilt only if `package.json` changes.

### `make start-dev`

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

The page will reload if you make edits.

This is a blank volto project with this add-on installed in development mode.

**Note:** removing the local `node_modules` might be necessary for the build to work, in order to avoid conflicts between the local dependencies and the ones built in the dev container.

### `make dev`

Same as `make start-dev` but this also runs a Plone backend.

### `make start-frontend`

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.

## Release

It is all configured for [release-it](https://github.com/release-it/release-it) and uses conventional changelog (see [COMMITLINT.md](./COMMITLINT.md)).
To run a release, just run:

```bash
yarn release
```

if you want to check the configuration, it is in [.release-it.json](./.release-it.json).

By default it will use the commits type and scope to determine the version following semantic 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:

```bash
yarn release -- major
```