A new project using Plone 6.
Ensure you have the following installed:
- Python 3.11 🐍
- Node 20 🟩
- yarn 🧶
- Docker 🐳
- Clone the repository:
git clone git@github.com:collective/plone-edu.git
cd plone-edu- Install both Backend and Frontend:
make install- Create a new Plone site on your first run:
make create-site- Start the Backend at http://localhost:8080/:
make start-backend- In a new terminal, start the Frontend at http://localhost:3000/:
make start-frontendVoila! Your Plone site should be live and kicking! 🎉
Deploy a local Docker Compose environment that includes:
- Docker images for Backend and Frontend 🖼️
- A stack with a Traefik router and a Postgres database 🗃️
- Accessible at http://plone-edu.localhost 🌐
Execute the following:
make stack-start
make stack-create-siteAnd... you're all set! Your Plone site is up and running locally! 🚀
This monorepo consists of three distinct sections: backend, frontend, and devops.
- backend: Houses the API and Plone installation, utilizing pip instead of buildout, and includes a policy package named plone_edu.
- frontend: Contains the React (Volto) package.
- devops: Encompasses Docker Stack, Ansible playbooks, and Cache settings.
- All necessary codebases to run the site are contained within the repo (excluding existing addons for Plone and React).
- Specific GitHub Workflows are triggered based on changes in each codebase (refer to .github/workflows).
- Simplifies the creation of Docker images for each codebase.
- Demonstrates Plone installation/setup without buildout.
To automatically format your code and ensure it adheres to quality standards, execute:
make formatLinters can be run individually within the backend or frontend folders.
Generate translation files for Plone and Volto with ease:
make i18nCrafted with care by This was generated by cookiecutter-plone-starter on 2024-03-07 10:10:53. A special thanks to all contributors and supporters!