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.
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.
Build a docker image to use for development and testing.
Needs to be rebuilt only if package.json changes.
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.
Same as make start-dev but this also runs a Plone backend.
Runs the compiled app in production.
You can again view your application at http://localhost:3000
Runs the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.
Runs the test i18n runner which extracts all the translation strings and generates the needed files.
It is all configured for release-it and uses conventional changelog (see COMMITLINT.md). To run a release, just run:
yarn releaseif you want to check the configuration, it is in .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:
yarn release -- major