Skip to content

plone/tagung.plone.de

Folders and files

NameName
Last commit message
Last commit date
Mar 4, 2025
Jan 30, 2025
Mar 14, 2025
Mar 4, 2025
Mar 15, 2025
Jan 30, 2025
Mar 11, 2025
Jan 30, 2025
Mar 10, 2025
Jan 30, 2025
Jan 30, 2025
Jan 30, 2025
Jan 30, 2025
Mar 10, 2025

Repository files navigation

tagung.plone.de πŸš€

Built with Cookieplone Black code style Backend Tests Frontend Tests

Plone Projekt fΓΌr die deutschsprachige Plone Tagung

Quick Start 🏁

Prerequisites βœ…

Ensure you have the following installed:

  • Python 3.11 🐍
  • Node 22 🟩
  • pnpm 🧢
  • Docker 🐳

Installation πŸ”§

  1. Clone the repository:
git clone git@github.com:collective/tagung-plone-de.git
cd tagung-plone-de
  1. Install both Backend and Frontend:
make install

Fire Up the Servers πŸ”₯

  1. Create a new Plone site on your first run:
make backend-create-site
  1. Start the Backend at http://localhost:8080/:
make backend-start
  1. In a new terminal, start the Frontend at http://localhost:3000/:
make frontend-start

Voila! Your Plone site should be live and kicking! πŸŽ‰

Local Stack Deployment πŸ“¦

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://tagung-plone-de.localhost 🌐

Execute the following:

make stack-start
make stack-create-site

And... you're all set! Your Plone site is up and running locally! πŸš€

Project Structure πŸ—οΈ

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 tagung.plone.de.
  • frontend: Contains the React (Volto) package.
  • devops: Encompasses Docker Stack, Ansible playbooks, and Cache settings.

Why This Structure? πŸ€”

  • 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.

Code Quality Assurance 🧐

To automatically format your code and ensure it adheres to quality standards, execute:

make check

Linters can be run individually within the backend or frontend folders.

Internationalization 🌐

Generate translation files for Plone and Volto with ease:

make i18n

Credits and Acknowledgements πŸ™

Crafted with care by Generated using Cookieplone (0.8.2) and cookiecutter-plone (a4778d4) on 2025-01-30 14:17:47.745217. A special thanks to all contributors and supporters!