0.6.0 • Published 10 months ago

@codesyntax/volto-newsletter v0.6.0

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

volto-newsletter

Volto add-on

Features

Demo GIF

Getting started

Try volto-newsletter with Docker

  1. Get the latest Docker images

    docker pull plone
    docker pull plone/volto
  2. Start Plone backend

    docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone
  3. Start Volto frontend

    docker run -it --rm -p 3000:3000 --link plone -e ADDONS="@eeacms/volto-newsletter" plone/volto
  4. Go to http://localhost:3000

Add volto-newsletter to your Volto project

  1. Make sure you have a Plone backend up-and-running at http://localhost:8080/Plone

  2. Start Volto frontend

  • If you already have a volto project, just update package.json:

    "addons": [
        "@codesyntax/volto-newsletter"
    ],
    
    "dependencies": {
        "@codesyntax/volto-newsletter": "^1.0.0"
    }
  • If not, create one:

    npm install -g yo @plone/generator-volto
    yo @plone/volto my-volto-project --addon @eeacms/volto-newsletter
    cd my-volto-project
  1. Install new add-ons and restart Volto:

    yarn
    yarn start
  2. Go to http://localhost:3000

  3. Happy editing!

Release

See RELEASE.md.

How to contribute

See DEVELOP.md.