PortalBrasil: Core 🚀

Componentes base do PortalBrasil.

Quick Start 🏁

Prerequisites ✅

Ensure you have the following installed:

• UV 🐍
• Node 22 🟩
• pnpm 🧶
• Docker 🐳

Installation 🔧

1. Clone the repository:

git clone git@github.com:portal-br/core.git
cd core

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

2. Start the Backend at http://localhost:8080/:

make backend-start

3. In a new terminal, start the Frontend at http://localhost:3000/:

make frontend-start

Voila! Your Plone site should be live and kicking! 🎉

Project Structure 🏗️

This monorepo consists of three distinct sections: backend and frontend.

• backend: Houses the API and Plone installation, utilizing pip instead of buildout, and includes a policy package named portalbrasil.core.
• frontend: Contains the React (Volto) package.

Code Quality Assurance 🧐

It is possible to only run format:

make format

or lint:

make lint

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 🙏

Generated using Cookieplone (0.8.4) and cookieplone-templates (86480b4) on 2025-03-23 14:53:53.605935. A special thanks to all contributors and supporters!