https://github.com/collective/volto-example-project-addons

This repo has the directions to setup your Volto project to work with addons
https://github.com/collective/volto-example-project-addons

Last synced: 5 days ago
JSON representation

This repo has the directions to setup your Volto project to work with addons

• Host: GitHub
• URL: https://github.com/collective/volto-example-project-addons
• Owner: collective
• Created: 2020-05-08T08:30:05.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-05-08T10:42:05.000Z (over 4 years ago)
• Last Synced: 2024-08-02T14:05:05.774Z (3 months ago)
• Language: JavaScript
• Size: 267 KB
• Stars: 2
• Watchers: 11
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-volto - Demo project for Volto addons

README

        
# Volto project with addons example

This is a Volto project (using Volto 5.x.x) that shows how to deal with addons as

released packages (ie. released in an npm registry) or locally while developing them.

## Branches

Two branches are provided in this repo:

- usingreleasedpackage

- usingmrsdeveloper

## Example package

Both use an example package `volto-testaddon`, which is released:

https://www.npmjs.com/package/volto-testaddon

and you can find it on github:

https://github.com/sneridagh/volto-testaddon

It features a view `DummyView` that this project will use to override the `Document` View.

## Trying it out (both branches)

Install deps:

`yarn`

start the project:

`yarn start`

## Setup your own project

Take a look at the changes for how to setup your project to work with add-ons.

### Using a released package

https://github.com/collective/volto-example-project-addons/pull/1

### Using mrs-developer

https://github.com/collective/volto-example-project-addons/pull/2