Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,29 @@ There are `Makefile` commands in place:

## Filestorage based backend alternative

The default setup assumes for local development you also have a PostgreSQL server running. As a convenience an example docker compose file is provided in the project root for such a service. If you prefer to use filestorage, you can look in the backend directory its Makefile and
look at the alternative 'build-dev-fs' target, which depends on 'config-fs'. The difference with the normal 'config' target is the usages of
instance-filestorage.yaml instead of instanc.yaml. These files are used as input for the application server scaffolding and switch the storage
layer to either relstorage/postgresql or direct/filestorage.
The default setup assumes for local development you also have a PostgreSQL server running. As a convenience, an example docker compose file is provided in the project root for such a service. If you prefer to use filestorage instead of PostgreSQL, you can configure the backend to use direct filestorage.

### Setup for filestorage development

1. **Create the data directory** at the project root:
```shell
mkdir data
```

2. **Configure the backend for filestorage** by copying the example configuration:
```shell
cp backend/instance-local.yaml.example backend/instance-local.yaml
```

3. **Install and start the backend** as usual:
```shell
make install
make start-backend
```

The Makefile will automatically detect and use the `instance-local.yaml` file when it exists, switching the storage layer from relstorage/PostgreSQL to direct filestorage.

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

Expand Down
4 changes: 3 additions & 1 deletion backend/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -115,12 +115,14 @@ i18n: bin/i18ndude ## Update locales
# TODO `make build`
# build:

.PHONY: build-dev
.PHONY: build-dev install
build-dev: config ## pip install Plone packages
@echo "$(GREEN)==> Setup Build$(RESET)"
sed "s/PLONE_VERSION/$(PLONE_VERSION)/g" constraints-template.txt > constraints.txt
@bin/mxdev -c mx.ini
bin/pip install -r requirements-mxdev.txt
# Forward compatibility
install: build-dev

.PHONY: format
format: ## Format the codebase according to our standards
Expand Down
8 changes: 4 additions & 4 deletions frontend/jsconfig.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"compilerOptions": {
"paths": {},
"baseUrl": "src"
}
"compilerOptions": {
"paths": {},
"baseUrl": "src"
}
}