Skip to content

Commit b0effaf

Browse files
committed
Update README.md with verified instructions
1 parent c5dca6d commit b0effaf

1 file changed

Lines changed: 31 additions & 18 deletions

File tree

README.md

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,47 +5,60 @@
55
[![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)
66
[![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)
77

8-
The main destination for Plone
8+
The main destination for Plone.
99

10-
## Quick start
10+
## Prerequisites
1111

12-
### Development Setup
12+
- Python 3.11
13+
- Node 16
14+
- yarn
15+
- Docker
16+
- Postgres 14
1317

14-
- Python 3.11
15-
- Node 16
16-
- yarn
17-
- Docker
18-
- Postgres 14
18+
See https://6.docs.plone.org/install/create-project-cookieplone.html#system-requirements for more details.
1919

20-
### Create database
2120

22-
```shell
23-
createdb ploneorg
24-
createuser ploneorg
25-
```
21+
## Development setup
2622

27-
### Install
23+
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.
24+
Note the username and password for the default administrator user in this file.
2825

2926
```shell
3027
git clone git@github.com:plone/plone.org.git
3128
cd plone.org
29+
cp ./backend/instance-local.yaml.example ./backend/instance-local.yaml
3230
make install
3331
```
3432

35-
### Start
33+
### Start the backend
3634

37-
Start the Backend (http://localhost:8080/)
35+
In the current terminal session, and start the backend.
3836

3937
```shell
4038
make start-backend
4139
```
4240

43-
Start the Frontend (http://localhost:3000/)
41+
42+
### Start the frontend
43+
44+
Open a new terminal session, and start the frontend.
4445

4546
```shell
4647
make start-frontend
4748
```
4849

50+
51+
### Complete setup
52+
53+
Visit http://localhost:3000/fallback_login and enter the administrator credentials you set in the previous step.
54+
55+
You'll see a scary error.
56+
Don't worry, this is expected.
57+
Visit the site root at http://localhost:3000/.
58+
59+
To populate the site with content, see [Getting data for development](#getting-data-for-development).
60+
61+
4962
## Structure
5063

5164
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
108121

109122
### Getting data for development
110123

111-
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.
124+
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.
112125

113126
## Credits
114127

0 commit comments

Comments
 (0)