Awesome
Cookiecutter Plone Starter 🌟
Welcome to Cookiecutter Plone Starter! Your one-stop solution to kickstart Plone 6 projects with ease and efficiency. Powered by Cookiecutter, this template is designed to save you time and ensure that you get started on the right foot. 🚀
Features ✨
- Tailored for Plone 6
- Compatible with Python 3.8, 3.9, 3.10, 3.11
- Leverages volto-generator for frontend code generation
Getting Started 🏁
Prerequisites
- pipx: A handy tool for installing and running Python applications.
- NodeJS & Yarn: Essential for managing and running JavaScript packages.
- Docker: For containerization and easy deployment. (Optional)
Installation Guide 🛠️
- pipx
pip install pipx
- NodeJS & Yarn
Follow the Plone documentation for detailed instructions.
- Docker
Visit the official documentation for installation guides.
Generate Your Plone 6 Project 🎉
pipx run cookiecutter gh:collective/cookiecutter-plone-starter
For alpha versions of Volto:
USE_VOLTO_ALPHA=1 pipx run cookiecutter gh:collective/cookiecutter-plone-starter
Use options to avoid prompts
The cookiecutter will ask a lot of questions. You can use some of its options to avoid repeatedly entering the same values.
--no-input
You can use the --no-input option to make the cookiecutter not prompt for parameters and only use cookiecutter.json file content.
--replay and --replay-file
You can use the options --replay and --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.
Initial Build
make install
Start Servers
Backend:
make start-backend
Frontend:
make start-frontend
Rebuild After Changes
make build
make start-backend
make start-frontend
Project Generation Options 🛠️
Every 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 |
|---|---|---|
project_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@example.com |
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 |
volto_addon_name | Name of the Volto addon package used to configure your frontend project. No spaces or special characters are allowed. | volto-plone-site |
python_test_framework | Select which Python testing framework to use in the project | pytest |
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 |
use_alpha_versions | Use non-stable versions of Volto, (The default value could also be set via USE_VOLTO_ALPHA environment variable. | Yes |
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 |
volto_generator_version | Volto (Plone Frontend) Yeoman generator to be used. This queries for the latest available Volto Generator version and presents it to you as the default value. Non-stable versions will be included if a non-stable version was selected for volto_version. | 6.0.0 |
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 |
Dive into Your Project's Structure 🏗️
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)
Code Quality Assurance 🧐
Your project 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!