-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathREADME.md.tpl
More file actions
107 lines (68 loc) · 3.89 KB
/
Copy pathREADME.md.tpl
File metadata and controls
107 lines (68 loc) · 3.89 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# <%= name %>
[](https://github.com/eea/<%= name %>/releases)
[](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/<%= name %>/job/master/display/redirect)
[](https://sonarqube.eea.europa.eu/dashboard?id=<%= name %>)
[](https://sonarqube.eea.europa.eu/dashboard?id=<%= name %>)
[](https://sonarqube.eea.europa.eu/dashboard?id=<%= name %>)
[](https://sonarqube.eea.europa.eu/dashboard?id=<%= name %>)
[](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/<%= name %>/job/develop/display/redirect)
[](https://sonarqube.eea.europa.eu/dashboard?id=<%= name %>&branch=develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=<%= name %>&branch=develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=<%= name %>&branch=develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=<%= name %>&branch=develop)
[Volto](https://github.com/plone/volto) add-on
## Features
Demo GIF
## Getting started
### Try <%= name %> with Docker
git clone https://github.com/eea/<%= name %>.git
cd <%= name %>
make
make start
Go to http://localhost:3000
`make start` now defaults to Volto 18. To run the same setup against Volto 17, use:
VOLTO_VERSION=17 make
VOLTO_VERSION=17 make start
### Add <%= name %> to your Volto project
1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
```Bash
docker compose up backend
```
1. Start Volto frontend
* If you already have a volto project, just update `package.json`:
```JSON
"dependencies": {
"<%= addonName %>": "*"
}
```
and `volto.config.js`:
```JavaScript
const addons = ['<%= addonName %>'];
```
* If not, create one with Cookieplone, as recommended by the official Plone documentation for Volto 18+:
```
uvx cookieplone project
cd project-title
```
1. Install or update dependencies, then start the project:
```
make install
```
For a Cookieplone project, start the backend and frontend in separate terminals:
```
make backend-start
make frontend-start
```
For a legacy Volto 17 project, install the package with `yarn` and restart the frontend as usual.
1. Go to http://localhost:3000
1. Happy editing!
## Release
See [RELEASE.md](https://github.com/eea/<%= name %>/blob/master/RELEASE.md).
## How to contribute
See [DEVELOP.md](https://github.com/eea/<%= name %>/blob/master/DEVELOP.md).
## Copyright and license
The Initial Owner of the Original Code is European Environment Agency (EEA).
All Rights Reserved.
See [LICENSE.md](https://github.com/eea/<%= name %>/blob/master/LICENSE.md) for details.
## Funding
[European Environment Agency (EU)](http://eea.europa.eu)