generated from eea/volto-addon-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #46 from eea/develop
Release
- Loading branch information
Showing
15 changed files
with
462 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # syntax=docker/dockerfile:1 | ||
| ARG VOLTO_VERSION | ||
| FROM plone/frontend-builder:${VOLTO_VERSION} | ||
|
|
||
| ARG ADDON_NAME | ||
| ARG ADDON_PATH | ||
|
|
||
| COPY --chown=node:node ./ /app/src/addons/${ADDON_PATH}/ | ||
|
|
||
| RUN /setupAddon | ||
| RUN yarn install | ||
|
|
||
| ENTRYPOINT ["yarn"] | ||
| CMD ["start"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,131 @@ | ||
| SHELL=/bin/bash | ||
| ############################################################################## | ||
| # Run: | ||
| # make | ||
| # make start | ||
| # | ||
| # Go to: | ||
| # | ||
| # http://localhost:3000 | ||
| # | ||
| # Cypress: | ||
| # | ||
| # make cypress-open | ||
| # | ||
| ############################################################################## | ||
| # SETUP MAKE | ||
| # | ||
| ## Defensive settings for make: https://tech.davis-hansson.com/p/make/ | ||
| SHELL:=bash | ||
| .ONESHELL: | ||
| # for Makefile debugging purposes add -x to the .SHELLFLAGS | ||
| .SHELLFLAGS:=-eu -o pipefail -O inherit_errexit -c | ||
| .SILENT: | ||
| .DELETE_ON_ERROR: | ||
| MAKEFLAGS+=--warn-undefined-variables | ||
| MAKEFLAGS+=--no-builtin-rules | ||
|
|
||
| # Colors | ||
| # OK=Green, warn=yellow, error=red | ||
| ifeq ($(TERM),) | ||
| # no colors if not in terminal | ||
| MARK_COLOR= | ||
| OK_COLOR= | ||
| WARN_COLOR= | ||
| ERROR_COLOR= | ||
| NO_COLOR= | ||
| else | ||
| MARK_COLOR=`tput setaf 6` | ||
| OK_COLOR=`tput setaf 2` | ||
| WARN_COLOR=`tput setaf 3` | ||
| ERROR_COLOR=`tput setaf 1` | ||
| NO_COLOR=`tput sgr0` | ||
| endif | ||
|
|
||
| ############################################################################## | ||
| # SETTINGS AND VARIABLE | ||
| DIR=$(shell basename $$(pwd)) | ||
| ADDON ?= "@eeacms/volto-slate-footnote" | ||
|
|
||
| # We like colors | ||
| # From: https://coderwall.com/p/izxssa/colored-makefile-for-golang-projects | ||
| RED=`tput setaf 1` | ||
| GREEN=`tput setaf 2` | ||
| RESET=`tput sgr0` | ||
| YELLOW=`tput setaf 3` | ||
|
|
||
| project: | ||
| npm install -g yo | ||
| npm install -g @plone/generator-volto | ||
| npm install -g mrs-developer | ||
| yo @plone/volto project --addon ${ADDON} --workspace "src/addons/${DIR}" --no-interactive | ||
| ln -sf $$(pwd) project/src/addons/ | ||
| cp .project.eslintrc.js .eslintrc.js | ||
| cd project && yarn | ||
| @echo "-------------------" | ||
| @echo "$(GREEN)Volto project is ready!$(RESET)" | ||
| @echo "$(RED)Now run: cd project && yarn start$(RESET)" | ||
|
|
||
| all: project | ||
|
|
||
| .PHONY: start-test-backend | ||
| start-test-backend: ## Start Test Plone Backend | ||
| @echo "$(GREEN)==> Start Test Plone Backend$(RESET)" | ||
| docker run -i --rm -e ZSERVER_HOST=0.0.0.0 -e ZSERVER_PORT=55001 -p 55001:55001 -e SITE=plone -e APPLY_PROFILES=plone.app.contenttypes:plone-content,plone.restapi:default,kitconcept.volto:default-homepage -e CONFIGURE_PACKAGES=plone.app.contenttypes,plone.restapi,kitconcept.volto,kitconcept.volto.cors -e ADDONS='plone.app.robotframework plone.app.contenttypes plone.restapi kitconcept.volto' plone ./bin/robot-server plone.app.robotframework.testing.PLONE_ROBOT_TESTING | ||
|
|
||
| .PHONY: start-backend-docker | ||
| start-backend-docker: ## Starts a Docker-based backend | ||
| @echo "$(GREEN)==> Start Docker-based Plone Backend$(RESET)" | ||
| docker run -it --rm --name=plone -p 8080:8080 -e SITE=Plone -e ADDONS="kitconcept.volto" -e ZCML="kitconcept.volto.cors" plone | ||
| NODE_MODULES?="../../../node_modules" | ||
| PLONE_VERSION?=6 | ||
| VOLTO_VERSION?=16 | ||
| ADDON_PATH="${DIR}" | ||
| ADDON_NAME="@eeacms/${ADDON_PATH}" | ||
| DOCKER_COMPOSE=PLONE_VERSION=${PLONE_VERSION} VOLTO_VERSION=${VOLTO_VERSION} ADDON_NAME=${ADDON_NAME} ADDON_PATH=${ADDON_PATH} docker compose | ||
|
|
||
| # Top-level targets | ||
| .PHONY: all | ||
| all: clean install | ||
|
|
||
| .PHONY: clean | ||
| clean: ## Cleanup development environment | ||
| ${DOCKER_COMPOSE} down --volumes --remove-orphans | ||
|
|
||
| .PHONY: install | ||
| install: ## Build and install development environment | ||
| echo "Running: ${DOCKER_COMPOSE} build" | ||
| ${DOCKER_COMPOSE} pull | ||
| ${DOCKER_COMPOSE} build | ||
|
|
||
| .PHONY: start | ||
| start: ## Start development environment | ||
| echo "Running: ${DOCKER_COMPOSE} up" | ||
| ${DOCKER_COMPOSE} up | ||
|
|
||
| .PHONY: shell | ||
| shell: ## Start a shell in the frontend container | ||
| echo "Running: ${DOCKER_COMPOSE} run frontend bash" | ||
| ${DOCKER_COMPOSE} run --entrypoint=bash frontend | ||
|
|
||
| .PHONY: cypress-open | ||
| cypress-open: ## Open cypress integration tests | ||
| NODE_ENV=development $(NODE_MODULES)/cypress/bin/cypress open | ||
|
|
||
| .PHONY: cypress-run | ||
| cypress-run: ## Run cypress integration tests | ||
| NODE_ENV=development $(NODE_MODULES)/cypress/bin/cypress run | ||
|
|
||
| .PHONY: test | ||
| test: | ||
| docker pull plone/volto-addon-ci:alpha | ||
| docker run -it --rm -e NAMESPACE="@eeacms" -e GIT_NAME="${DIR}" -e RAZZLE_JEST_CONFIG=jest-addon.config.js -v "$$(pwd):/opt/frontend/my-volto-project/src/addons/${DIR}" -e CI="true" plone/volto-addon-ci:alpha | ||
| test: ## Run jest tests | ||
| ${DOCKER_COMPOSE} run -e CI=1 frontend test | ||
|
|
||
| .PHONY: test-update | ||
| test-update: | ||
| docker pull plone/volto-addon-ci:alpha | ||
| docker run -it --rm -e NAMESPACE="@eeacms" -e GIT_NAME="${DIR}" -e RAZZLE_JEST_CONFIG=jest-addon.config.js -v "$$(pwd):/opt/frontend/my-volto-project/src/addons/${DIR}" -e CI="true" plone/volto-addon-ci:alpha yarn test src/addons/${DIR}/src --watchAll=false -u | ||
| test-update: ## Update jest tests snapshots | ||
| ${DOCKER_COMPOSE} run -e CI=1 frontend test -u | ||
|
|
||
| .PHONY: stylelint | ||
| stylelint: ## Stylelint | ||
| $(NODE_MODULES)/stylelint/bin/stylelint.js --allow-empty-input 'src/**/*.{css,less}' | ||
|
|
||
| .PHONY: stylelint-overrides | ||
| stylelint-overrides: | ||
| $(NODE_MODULES)/.bin/stylelint --syntax less --allow-empty-input 'theme/**/*.overrides' 'src/**/*.overrides' | ||
|
|
||
| .PHONY: stylelint-fix | ||
| stylelint-fix: ## Fix stylelint | ||
| $(NODE_MODULES)/stylelint/bin/stylelint.js --allow-empty-input 'src/**/*.{css,less}' --fix | ||
| $(NODE_MODULES)/.bin/stylelint --syntax less --allow-empty-input 'theme/**/*.overrides' 'src/**/*.overrides' --fix | ||
|
|
||
| .PHONY: prettier | ||
| prettier: ## Prettier | ||
| $(NODE_MODULES)/.bin/prettier --single-quote --check 'src/**/*.{js,jsx,json,css,less,md}' | ||
|
|
||
| .PHONY: prettier-fix | ||
| prettier-fix: ## Fix prettier | ||
| $(NODE_MODULES)/.bin/prettier --single-quote --write 'src/**/*.{js,jsx,json,css,less,md}' | ||
|
|
||
| .PHONY: lint | ||
| lint: ## ES Lint | ||
| $(NODE_MODULES)/eslint/bin/eslint.js --max-warnings=0 'src/**/*.{js,jsx}' | ||
|
|
||
| .PHONY: lint-fix | ||
| lint-fix: ## Fix ES Lint | ||
| $(NODE_MODULES)/eslint/bin/eslint.js --fix 'src/**/*.{js,jsx}' | ||
|
|
||
| .PHONY: i18n | ||
| i18n: ## i18n | ||
| rm -rf build/messages | ||
| NODE_ENV=development $(NODE_MODULES)/.bin/i18n --addon | ||
|
|
||
| .PHONY: help | ||
| help: ## Show this help. | ||
| help: ## Show this help. | ||
| @echo -e "$$(grep -hE '^\S+:.*##' $(MAKEFILE_LIST) | sed -e 's/:.*##\s*/:/' -e 's/^\(.\+\):\(.*\)/\\x1b[36m\1\\x1b[m:\2/' | column -c2 -t -s :)" | ||
| head -n 14 Makefile |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| version: "3" | ||
| services: | ||
| backend: | ||
| image: eeacms/plone-backend | ||
| ports: | ||
| - "8080:8080" | ||
| environment: | ||
| SITE: "Plone" | ||
| PROFILES: "eea.kitkat:testing" | ||
|
|
||
| frontend: | ||
| build: | ||
| context: ./ | ||
| dockerfile: ./Dockerfile | ||
| args: | ||
| ADDON_NAME: "${ADDON_NAME}" | ||
| ADDON_PATH: "${ADDON_PATH}" | ||
| VOLTO_VERSION: ${VOLTO_VERSION:-16} | ||
| ports: | ||
| - "3000:3000" | ||
| - "3001:3001" | ||
| depends_on: | ||
| - backend | ||
| volumes: | ||
| - ./:/app/src/addons/${ADDON_PATH} | ||
| environment: | ||
| CI: "true" | ||
| NODE_ENV: "development" | ||
| RAZZLE_JEST_CONFIG: "src/addons/${ADDON_PATH}/jest-addon.config.js" | ||
| RAZZLE_INTERNAL_API_PATH: "http://backend:8080/Plone" | ||
| RAZZLE_DEV_PROXY_API_PATH: "http://backend:8080/Plone" | ||
| HOST: "0.0.0.0" |
Oops, something went wrong.