|
5 | 5 | [](https://github.com/plone/plone.org/actions/workflows/backend-testing.yaml) |
6 | 6 | [](https://github.com/plone/plone.org/actions/workflows/frontend-testing.yml) |
7 | 7 |
|
8 | | -The main destination for Plone |
| 8 | +The main destination for Plone. |
9 | 9 |
|
10 | | -## Quick start |
| 10 | +## Prerequisites |
11 | 11 |
|
12 | | -### Development Setup |
| 12 | +- Python 3.11 |
| 13 | +- Node 16 |
| 14 | +- yarn |
| 15 | +- Docker |
| 16 | +- Postgres 14 |
13 | 17 |
|
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. |
19 | 19 |
|
20 | | -### Create database |
21 | 20 |
|
22 | | -```shell |
23 | | -createdb ploneorg |
24 | | -createuser ploneorg |
25 | | -``` |
| 21 | +## Development setup |
26 | 22 |
|
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. |
28 | 25 |
|
29 | 26 | ```shell |
30 | 27 | git clone git@github.com:plone/plone.org.git |
31 | 28 | cd plone.org |
| 29 | +cp ./backend/instance-local.yaml.example ./backend/instance-local.yaml |
32 | 30 | make install |
33 | 31 | ``` |
34 | 32 |
|
35 | | -### Start |
| 33 | +### Start the backend |
36 | 34 |
|
37 | | -Start the Backend (http://localhost:8080/) |
| 35 | +In the current terminal session, and start the backend. |
38 | 36 |
|
39 | 37 | ```shell |
40 | 38 | make start-backend |
41 | 39 | ``` |
42 | 40 |
|
43 | | -Start the Frontend (http://localhost:3000/) |
| 41 | + |
| 42 | +### Start the frontend |
| 43 | + |
| 44 | +Open a new terminal session, and start the frontend. |
44 | 45 |
|
45 | 46 | ```shell |
46 | 47 | make start-frontend |
47 | 48 | ``` |
48 | 49 |
|
| 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 | + |
49 | 62 | ## Structure |
50 | 63 |
|
51 | 64 | 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 |
108 | 121 |
|
109 | 122 | ### Getting data for development |
110 | 123 |
|
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. |
112 | 125 |
|
113 | 126 | ## Credits |
114 | 127 |
|
|
0 commit comments