@plone-collective/fortytwo
v1.0.0-alpha.1
Published
Helper for creating Seven-powered sites on top of Plone 6
Downloads
3
Readme
Fortytwo (@plone-collective/fortytwo)
Helper for creating Seven-powered sites on top of Plone 6
Features
Installation
To install your project, you must choose the method appropriate to your version of Volto.
Volto 18 and later
Add @plone-collective/fortytwo to your package.json:
"dependencies": {
"@plone-collective/fortytwo": "*"
}Add @plone-collective/fortytwo to your volto.config.js:
const addons = ['@plone-collective/fortytwo'];If this package provides a Volto theme, and you want to activate it, then add the following to your volto.config.js:
const theme = '@plone-collective/fortytwo';Volto 17 and earlier
Create a new Volto project (you can skip this step if you already have one):
npm install -g yo @plone/generator-volto
yo @plone/volto my-volto-project --addon @plone-collective/fortytwo
cd my-volto-projectAdd @plone-collective/fortytwo to your package.json:
"addons": [
"@plone-collective/fortytwo"
],
"dependencies": {
"@plone-collective/fortytwo": "*"
}Download and install the new add-on by running:
yarn installStart volto with:
yarn startTest installation
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).
Prerequisites ✅
- An operating system that runs all the requirements mentioned.
- nvm
- Node.js and pnpm 22
- Make
- Git
- Docker (optional)
Installation 🔧
Clone this repository, then change your working directory.
git clone [email protected]:collective/fortytwo.git cd fortytwoInstall this code base.
make install
Make convenience commands
Run make help to list the available commands.
help Show this help
install Installs the add-on in a development environment
start Starts Volto, allowing reloading of the add-on during development
build Build a production bundle for distribution of the project with the add-on
i18n Sync i18n
ci-i18n Check if i18n is not synced
format Format codebase
lint Lint, or catch and remove problems, in code base
release Release the add-on on npmjs.org
release-dry-run Dry-run the release of the add-on on npmjs.org
test Run unit tests
ci-test Run unit tests in CI
backend-docker-start Starts a Docker-based backend for development
storybook-start Start Storybook server on port 6006
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
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 CIDevelopment environment set up
Install package requirements.
make installStart developing
Start the backend.
make backend-docker-startIn a separate terminal session, start the frontend.
make startLint code
Run ESlint, Prettier, and Stylelint in analyze mode.
make lintFormat code
Run ESlint, Prettier, and Stylelint in fix mode.
make formati18n
Extract the i18n messages to locales.
make i18nUnit tests
Run unit tests.
make testRun Cypress tests
Run each of these steps in separate terminal sessions.
In the first session, start the frontend in development mode.
make acceptance-frontend-dev-startIn the second session, start the backend acceptance server.
make acceptance-backend-startIn the third session, start the Cypress interactive test runner.
make acceptance-testLicense
The project is licensed under the MIT license.
Credits and acknowledgements 🙏
Generated using Cookieplone (0.9.9) and cookieplone-templates (62683ae) on 2025-10-15 23:52:37.197281. A special thanks to all contributors and supporters!
