README.md

Cookieplone Frontend Add-on

Powered by cookieplone and Cookiecutter, Cookieplone Frontend Add-on is intended to be used by Plone developers to create new add-on packages for Volto.

Getting Started 🏁

Prerequisites

• pipx: A handy tool for installing and running Python applications.

Installation Guide 🛠️

1. pipx

pip install pipx

Generate Your Plone Add-on 🎉

pipx run cookieplone frontend_addon

Project Generation Options

These are all the template options that will be prompted by the Cookiecutter CLI before generating your project.

Option	Description	Example
frontend_addon_name	Your addon's short name.	volto-weather-block
title	Your addon's human-readable name, capitals and spaces allowed.	Weather Block for Volto
description	Describes your add-on and gets used in places like README.md and such.	Add a weather block to your site.
author	This is you! The value goes into places like LICENSE, package.json and such.	Our Company
email	The email address you want to identify yourself in the project.	[email protected]
github_organization	Used for GitHub repositories.	collective
npm_package_name	Name of the Node package, including the organization (if any).	@plone-collective/volto-weather-block
volto_version	Volto version to be used.	18.0.0-alpha.31

Code Quality Assurance 🧐

Your package comes equipped with linters to ensure code quality. Run the following to automatically format your code:

make format

Internationalization 🌐

Generate translation files with ease:

make i18n

License 📜

This project is licensed under the MIT License.

Let's Get Building! 🚀

Happy coding!