Giter Club home page Giter Club logo

ploneconf2023's Introduction

Plone Conference Training ๐Ÿš€

Built with Cookiecutter Plone Starter Black code style Backend Tests Frontend Tests

A new project using Plone 6.

Quick Start ๐Ÿ

Prerequisites โœ…

Ensure you have the following installed:

  • Python 3.11 ๐Ÿ
  • Node 18 ๐ŸŸฉ
  • yarn ๐Ÿงถ
  • Docker ๐Ÿณ

Installation ๐Ÿ”ง

  1. Clone the repository:
git clone [email protected]:pbauer/ploneconf2023.git
cd ploneconf2023
  1. Install both Backend and Frontend:
make install

Fire Up the Servers ๐Ÿ”ฅ

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

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://ploneconf2023.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 ploneconf2023.
  • frontend: Contains the React (Volto) package.
  • devops: Encompasses Docker Stack and Ansible playbooks.

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 format

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 This was generated by cookiecutter-plone-starter on 2023-10-03 11:52:01. A special thanks to all contributors and supporters!

ploneconf2023's People

Contributors

pbauer avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.