Skip to content

Latest commit

 

History

History
196 lines (137 loc) · 18.7 KB

README.md

File metadata and controls

196 lines (137 loc) · 18.7 KB
Raw

Volto - the default Plone 6 frontend

Volto logo png

Volto logo png

NPM Unit Tests Acceptance Tests Build Status Docs

Introduction

Volto is a ReactJS-based frontend for the Plone Content Management System. It is the default frontend starting with the Plone 6 release.

Plone is a CMS built on Python with more than 20 years of history and experience.

Plone has features that appeal to developers and users alike, such as an intuitive editing interface, customizable content types, hierarchical organization, and a sophisticated permissions model. This allows you to build anything from simple websites to enterprise-grade intranets.

Volto exposes all these features and communicates with Plone via its REST API.

Volto features the Pastanaga editor, a modern block-based content layout editor. It is extensible and customizable, so you can adapt the provided default blocks to meet your requirements, or build new ones.

Volto is extensible using add-ons. You can build your own or choose from the community released ones:

Demo

You can try a Volto online demo at https://demo.plone.org/.

Monorepo structure

Since version 18.0.0-alpha4, the Volto core repository has had the shape of a monorepo, where "mono" means "single" and "repo" is short for "repository". This means that several apps and libraries related to each other are stored in the same repository. They are managed together but released individually. This allows the code to be shared effectively, and unifies tracking of changes across all of the apps and libraries.

Package Location
@plone/client packages/client
@plone/components packages/components
@plone/generator-volto packages/generator-volto
@plone/helpers packages/helpers
@plone/providers packages/providers
@plone/registry packages/registry
@plone/scripts packages/scripts
@plone/types packages/types
none packages/volto-guillotina
@plone/volto-slate packages/volto-slate
@plone/volto-testing packages/volto-testing

See also Monorepo structure.

Create a Volto project

To start a new project using Volto, follow the Plone installation documentation.

Documentation

You can find the latest documentation at https://6.docs.plone.org/.

For links to trainings and videos, see Other learning resources.

Supported Plone, Python, and Plone REST API versions

See Plone, Python, and Plone REST API compatibility

See the Plone Release Schedule for details of maintenance and support.

Supported Node.js versions

See Node.js version policy.

Supported browsers

See Supported browsers.

Contributing

To contribute to the Volto project by writing code, documentation, translations, and so on, please read Contributing to Plone and Contributing to Volto.

For newcomers to Volto, Plone, or open source software, you must read and follow First-time contributors.

Since December 2023, this repository has a monorepo structure. Volto itself is treated as a library and you can find it in the packages/volto folder.

Contributors

License

MIT License. Copyrights held by the Plone Foundation.

See LICENSE.md for details.

Volto in production

Volto has been actively developed since 2017. It has been used in production since 2018 on numerous websites.

The authoritative source of the list of Volto websites in production is maintained at Awesome Volto.

The Plone Marketing Team copy-pastes its content on a quarterly basis into They use Plone 6.

To ensure your website gets the greatest exposure, add it both to Awesome Volto and this README.

Open-source websites built with Volto

The following websites have been built with Volto. You can find their complete source code by following their links. Please note that complex websites are built on top of Volto add-ons, and most of the time they're just an empty shell for the add-ons. You should check the dependencies in their package.json for more details.