Welcome to Cookieplone Plone Project! Your one-stop solution to kickstart Plone 6 projects with ease and efficiency. Powered by cookieplone and Cookiecutter, this template is designed to save you time and ensure that you get started on the right foot. 🚀
- Tailored for Plone 6
- Compatible with Python 3.8, 3.9, 3.10, 3.11, 3.12
- pipx: A handy tool for installing and running Python applications.
- NodeJS & pnpm: Essential for managing and running JavaScript packages.
- pipx
pip install pipx- NodeJS & pnpm
Follow the Plone documentation for detailed instructions.
pipx run cookieplone projectCookieplone will ask a lot of questions. You can use some of its options to avoid repeatedly entering the same values.
You can use the --no_input option to make cookieplone not prompt for parameters and only use cookiecutter.json file content.
You can use the option --replay-file to not prompt for parameters and only use information entered previously or from a specified file.
See Replay Project Generation in the cookiecutter documentation for more information.
make installBackend:
make backend-startFrontend:
make frontend-startmake install
make backend-start
make frontend-startEvery project is unique, and we provide a variety of options to ensure that your Plone 6 project aligns with your specific needs. Here are the options you can customize during the generation process:
| Option | Description | Example |
|---|---|---|
title |
Your project's human-readable name, capitals and spaces allowed. | Plone Site |
description |
Describes your project and gets used in places like README.md and such. |
New site for our company. |
project_slug |
Your project's slug without spaces. Used to name your repository and Docker images. | plone-site |
hostname |
Hostname where the project will be deployed. | site.plone.org |
author |
This is you! The value goes into places like LICENSE, setup.py and such. |
Our Company |
email |
The email address you want to identify yourself in the project. | [email protected] |
use_prerelease_versions |
Use non-stable versions of Plone and Volto, (The default value could also be set via USE_PRERELEASE environment variable. |
Yes |
plone_version |
Plone version to be used. This queries for the latest available Plone 6 version and presents it to you as the default value. | 6.0.0 |
volto_version |
Volto (Plone Frontend) version to be used. This queries for the latest available Volto version and presents it to you as the default value. | 16.4.1 |
python_package_name |
Name of the Python package used to configure your project. It needs to be Python-importable, so no dashes, spaces or special characters are allowed. | plone_site |
frontend_addon_name |
Name of the Volto addon package used to configure your frontend project. No spaces or special characters are allowed. | volto-plone-site |
language_code |
Language to be used on the site. | pt-br |
github_organization |
Used for GitHub, GitLab, and Docker repositories. | collective |
container_registry |
Container registry to be used. | github |
devops_ansible |
Should we create an Ansible playbook to bootstrap and deploy this project? | Yes |
devops_gha_deploy |
Should we create a GitHub action to deploy this project? | Yes |
Your generated project will have a well-organized structure, ensuring that both development and maintenance are a breeze. It includes separate sections for backend, frontend, and devops, each tailored for its specific role.
(Include the Structure and Reasoning section from the previous README.md here, as it provides a good overview of the project structure)
Your project comes equipped with linters to ensure code quality. Run the following to automatically format your code:
make formatGenerate translation files with ease:
make i18nThis project is licensed under the MIT License.
Happy coding!