Skip to content

Commit

Permalink
WIP cleanup makefile, add stop command for acceptance server
Browse files Browse the repository at this point in the history
  • Loading branch information
reekitconcept committed Dec 20, 2024
1 parent ca02142 commit 46bb13c
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 19 deletions.
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -144,14 +144,14 @@ acceptance-frontend-prod-start: ## Start acceptance frontend in production mode

.PHONY: acceptance-backend-start
acceptance-backend-start: ## Start backend acceptance server
# docker run -it --rm -p 55001:55001 $(DOCKER_IMAGE_ACCEPTANCE)
# ${ACCEPTANCE} --profile prod up -d
${ACCEPTANCE} up -d

.PHONY: acceptance-backend-stop
acceptance-backend-stop: ## Stop backend acceptance server
${ACCEPTANCE} down

.PHONY: ci-acceptance-backend-start
ci-acceptance-backend-start: ## Start backend acceptance server in headless mode for CI
# docker run -i --rm -p 55001:55001 $(DOCKER_IMAGE_ACCEPTANCE)
# ${ACCEPTANCE} --profile dev up -d
${ACCEPTANCE} up -d

.PHONY: acceptance-test
Expand Down
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ const theme = '@kitconcept/volto-solr';

The configuration is provided by default and can be overwritten from any package.


### Result type templates

The search results are rendered by default components, which are customizable.
Expand Down Expand Up @@ -127,21 +126,18 @@ The rest of the options provide the baselines for the package and the `Search` c

## Test installation

Visit http://localhost:3000/ in a browser, login, and check the awesome new features.

Visit <http://localhost:3000/> in a browser, login, and check the awesome new features.

## Development

The development of this add-on is done in isolation using a new approach using pnpm workspaces and latest `mrs-developer` and other Volto core improvements.
For this reason, it only works with pnpm and Volto 18 (currently in alpha).


### Pre-requisites

- [Node.js](https://6.docs.plone.org/install/create-project.html#node-js)
- [Make](https://6.docs.plone.org/install/create-project.html#make)
- [Docker](https://6.docs.plone.org/install/create-project.html#docker)

- [Node.js](https://6.docs.plone.org/install/create-project.html#node-js)
- [Make](https://6.docs.plone.org/install/create-project.html#make)
- [Docker](https://6.docs.plone.org/install/create-project.html#docker)

### Make convenience commands

Expand All @@ -166,6 +162,7 @@ storybook-build Build Storybook
acceptance-frontend-dev-start Start acceptance frontend in development mode
acceptance-frontend-prod-start Start acceptance frontend in production mode
acceptance-backend-start Start backend acceptance server
acceptance-backend-stop Stop backend acceptance server
ci-acceptance-backend-start Start backend acceptance server in headless mode for CI
acceptance-test Start Cypress in interactive mode
ci-acceptance-test Run cypress tests in headless mode for CI
Expand Down Expand Up @@ -247,6 +244,12 @@ In the third session, start the Cypress interactive test runner.
make acceptance-test
```

There is also a stop command for the backend acceptance server.

```shell
make acceptance-backend-stop
```

## License

The project is licensed under the MIT license.
Expand Down
2 changes: 0 additions & 2 deletions acceptance/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
version: '3'

services:
backend-acceptance:
image: plone/plone-backend:${PLONE_VERSION:-6}
Expand Down
2 changes: 2 additions & 0 deletions acceptance/solr/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Acceptance Tests Solr Configuration

Important - This configuration folder is for the acceptance tests **ONLY**. Do not configure or copy it.

The solr configuration for an application is taken from the kitconcept.solr back-end package, and can be copied in order to be customized locally from there.
7 changes: 2 additions & 5 deletions dockerfiles/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
version: "3"

services:

addon-dev:
build:
context: ../
dockerfile: ./dockerfiles/Dockerfile.dev
args:
ADDON_NAME: "${ADDON_NAME}"
ADDON_PATH: "${ADDON_PATH}"
ADDON_NAME: '${ADDON_NAME}'
ADDON_PATH: '${ADDON_PATH}'
VOLTO_VERSION: ${VOLTO_VERSION:-16}
volumes:
- ${CURRENT_DIR}:/app/src/addons/${ADDON_PATH}/
Expand Down

0 comments on commit 46bb13c

Please sign in to comment.