From b0effaf61e5181bdd2f4ac15d752bc23c05478de Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 19 Mar 2026 02:07:42 -0700 Subject: [PATCH 1/2] Update README.md with verified instructions --- README.md | 49 +++++++++++++++++++++++++++++++------------------ 1 file changed, 31 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 4235cf9..4f550bd 100644 --- a/README.md +++ b/README.md @@ -5,47 +5,60 @@ [![Backend testing.plone.org CI and Deploy](https://github.com/plone/plone.org/actions/workflows/backend-testing.yaml/badge.svg)](https://github.com/plone/plone.org/actions/workflows/backend-testing.yaml) [![Frontend testing.plone.org CI and deploy](https://github.com/plone/plone.org/actions/workflows/frontend-testing.yml/badge.svg)](https://github.com/plone/plone.org/actions/workflows/frontend-testing.yml) -The main destination for Plone +The main destination for Plone. -## Quick start +## Prerequisites -### Development Setup +- Python 3.11 +- Node 16 +- yarn +- Docker +- Postgres 14 -- Python 3.11 -- Node 16 -- yarn -- Docker -- Postgres 14 +See https://6.docs.plone.org/install/create-project-cookieplone.html#system-requirements for more details. -### Create database -```shell -createdb ploneorg -createuser ploneorg -``` +## Development setup -### Install +Clone the repository, change your working directory to the root of the repository, prepare the configuration file, and install the project with both a backend and frontend. +Note the username and password for the default administrator user in this file. ```shell git clone git@github.com:plone/plone.org.git cd plone.org +cp ./backend/instance-local.yaml.example ./backend/instance-local.yaml make install ``` -### Start +### Start the backend -Start the Backend (http://localhost:8080/) +In the current terminal session, and start the backend. ```shell make start-backend ``` -Start the Frontend (http://localhost:3000/) + +### Start the frontend + +Open a new terminal session, and start the frontend. ```shell make start-frontend ``` + +### Complete setup + +Visit http://localhost:3000/fallback_login and enter the administrator credentials you set in the previous step. + +You'll see a scary error. +Don't worry, this is expected. +Visit the site root at http://localhost:3000/. + +To populate the site with content, see [Getting data for development](#getting-data-for-development). + + ## Structure This monorepo is composed by two distinct codebases: backend and frontend. @@ -108,7 +121,7 @@ The Makefile will automatically detect and use the `instance-local.yaml` file wh ### Getting data for development -For both storages, if you want to develop for plone.org and need a copy of the data, you will need to as another community member (preferably from the website-team or the AI-team) for a database dump. +For both storages, if you want to develop for plone.org and need a copy of the data, you'll need to ask another community member (preferably from the website-team or the AI-team) for a database dump. ## Credits From 5b569ea7cca5c2f22df5ae27af3744d4d10d087f Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 19 Mar 2026 02:09:17 -0700 Subject: [PATCH 2/2] change log --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8cca00a..3afb6da 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ - Add slate tables css. [acsr,fredvd] - Fix collection of dot-directories like .well-known in frontend for funding-manifest-urls (Fixes #222) [fredvd] - Add new sponsorship level +- Update `README.md` with verified instructions to get started. ## 1.0.21 (2026-01-19)