@plone-collective/volto-speakerdeck
v1.0.0-alpha.2
Published
Add decks from Speakerdeck in your Plone site.
Downloads
16
Readme
Speakerdeck content in Plone (@plone-collective/volto-speakerdeck)
Add decks from Speakerdeck in your Plone site.
Features
Add a block to display Speakerdeck's decks in a Plone site.
Install
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/volto-speakerdeck
cd my-volto-project
Add @plone-collective/volto-speakerdeck
to your package.json:
"addons": [
"@plone-collective/volto-speakerdeck"
],
"dependencies": {
"@plone-collective/volto-speakerdeck": "*"
}
Download and install the new add-on by running:
yarn install
Start volto with:
yarn start
Test it
Go to http://localhost:3000/, 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)
Requisites
- Volto 18
- pnpm as package manager
Make convenience commands
Run make help
to list the available commands.
help Show this help
install Installs the dev environment using mrs-developer
i18n Sync i18n
format Format codebase
lint Lint Codebase
test Run unit tests
test-ci Run unit tests in CI
storybook-start Start Storybook server on port 6006
storybook-build Build Storybook
start-backend-docker Starts a Docker-based backend for developing
start-test-acceptance-frontend-dev Start acceptance frontend in dev mode
start-test-acceptance-frontend Start acceptance frontend in prod mode
start-test-acceptance-server Start acceptance server
test-acceptance Start Cypress in interactive mode
test-acceptance-headless Run cypress tests in headless mode for CI
Development Environment Setup
Install package requirements
make install
Start developing
Run (in separate terminal sessions)
Start backend server
make start-backend-docker
Start frontend
pnpm start
Linting
Run ESlint, Prettier and Stylelint
make lint
Formatting
Run ESlint, Prettier and Stylelint in fix mode
make format
i18n
Extract the i18n messages to locales
make i18n
Unit tests
Run unit tests
make test
Run Cypress tests
Run (in separate terminal sessions)
Start the frontend in dev mode
make start-test-acceptance-frontend-dev
Start the backend acceptance server
make start-test-acceptance-server
Start the Cypress interactive test runner
make test-acceptance
License
The project is licensed under the MIT license.