Skip to content

Installing Volto

Volto can be installed in any operating system assuming that the requirements are met:

Depending on the OS that you are using some of the following might change, they are assuming a MacOS/Linux machine:

Install nvm (NodeJS version manager)

  1. Open a terminal console and type:

    $ touch ~/.bash_profile
    $ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash
    

  2. Close the terminal and open a new one or execute:

    $ source ~/.bash_profile
    

  3. Test it:

    $ nvm version
    

  4. Install latest NodeJS 10.x:

    $ nvm install 10.15.1
    $ nvm use 10.15.1
    

  5. Test NodeJS:

    $ node -v
    

Yarn (NodeJS package manager)

Install the node package manager.

  1. Open a terminal and type:

    $ curl -o- -L https://yarnpkg.com/install.sh | bash
    

  2. Test it, running:

    $ yarn -v
    

Tip

You can install yarn using several approaches too, depending on the platform you are on. Take a look at the original yarn documentation for a list of them.

Docker for Mac

In order to run the API backend, it's better to start running it in a container.

Here are the detailed instructions:

https://hub.docker.com/editions/community/docker-ce-desktop-mac
  1. Download the .dmg from:

    https://download.docker.com/mac/stable/Docker.dmg

  2. Install the package as any other Mac software, if required, follow instructions from:

    https://docs.docker.com/docker-for-mac/install/

  3. Check that docker is installed correctly, open a new terminal and type:

    $ docker ps
    
    should not throw an error and show the current running containers.

Install and run the ready to use Plone API Docker container

We need the backend for Volto running in our machine, so there's an image ready for it published in the Docker Hub. You can run it right away by issuing:

$ docker run --rm -it -p 8080:8080 kitconcept/plone.restapi:latest
from the command line. There's also a docker-compose config ready to run in any Volto project boilerplate (see next section).

Install Volto

Use the create-volto-app.

  1. Open a terminal and execute:
    $ npm -g i @plone/create-volto-app
    

Tip

Optionally, you can also use npx utility to install create-volto-app without having to install it globally. On the other hand, in order to do it, you have to install npx globally. The advantage is that you don't have to upgrade create-volto-app each time you want to use it, because npx does it for you:

npx @plone/create-volto-app myvoltoapp

  1. Create a new Volto app using the recently added command, providing the name of the new app (folder) to be created.

    $ create-volto-app myvoltoapp
    

  2. Change directory to the newly created folder myvoltoapp (or the one you've chosen). Then

    $ yarn start
    

Volto should compile and be executed in development mode. Open a browser to take a look at http://localhost:3000

Compile the production build

In production enviroments, you can compile an static version of the app. The app should be run in a node process (because of the server side rendering part), but also have a client part that is provided and deployed by the server side rendering process.

  1. Compile the app using the command:

    $ yarn build
    
    The resultant build is available in the dist folder.

  2. Run the Volto Nodejs process

    $ yarn start:prod
    

to run the node process with the production build. You can also run it manually:

$ NODE_ENV=production node build/server.js
Volto will be available in http://localhost:3000