Creating a new Volto project#
For using Volto for a project (i.e. use Volto as a library), You should use Volto's project generator
@plone/generator-volto. It's a boilerplate generator based in Yeoman that will provide you with the basic files and folder structure to bootstrap a Volto site. In addition to bootstrapping standalone Volto projects, it can also bootstrap Volto addons.
Open a terminal and execute:
npm init yo @plone/volto
Answer to the prompted questions and provide the name of the new app (folder) to be created. For the sake of this documentation, provide
myvoltoprojectas project name then.
This is the shortcut for using
npm init command. It uses Yeoman (
@plone/generator-volto and execute them without having to be installed globally. However, more advanced options for the generator are available, but you'll have to install it and run it without
$ npm install -g yo $ npm install -g @plone/generator-volto $ yo @plone/volto --help
Change directory to the newly created folder
myvoltoapp(or the one you've chosen).
$ cd myvoltoapp
The project is ready to be started,
@plone/generator-voltoalready has run the dependencies installations for you.will start the development server, compiling and leaving the app ready at: http://localhost:3000
$ yarn start