https://github.com/pluginpal/strapi-plugin-boilerplate
A test-driven template for building reliable Strapi v5 plugins
https://github.com/pluginpal/strapi-plugin-boilerplate
Last synced: over 1 year ago
JSON representation
A test-driven template for building reliable Strapi v5 plugins
- Host: GitHub
- URL: https://github.com/pluginpal/strapi-plugin-boilerplate
- Owner: pluginpal
- License: mit
- Created: 2025-01-03T09:20:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-20T21:10:27.000Z (over 1 year ago)
- Last Synced: 2025-01-24T03:25:51.919Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 862 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Strapi v5 Plugin Boilerplate
A test-driven template for building reliable Strapi v5 Plugins
## ✨ Features
- [x] Setup using [@strapi/sdk-plugin](https://github.com/strapi/sdk-plugin) with commands for `build` and `watch`.
- [x] An isolated Strapi instance for testing and development, the Playground.
- [x] Github Actions workflow for linting and testing.
- [x] Clear community files like [CONTRIBUTING.md](https://github.com/pluginpal/strapi-plugin-boilerplate/blob/main/CONTRIBUTING.md) and [CODE-OF-CONDUCT.md](https://github.com/pluginpal/strapi-plugin-boilerplate/blob/main/CODE_OF_CONDUCT.md).
- [x] Jest & Supertest for testing your plugin API's.
- [x] Cypress for GUI e2e tests
## ⏳ How to use
This repository is meant to be a template for new plugins. It can be used as a starting point, giving you the resources to built a test-driven Strapi v5 plugin.
After creating your copy of the template, do a find-replace through the code and change the following:
1. Change `boilerplate` (lowercase) to be the identifier of your plugin.
2. Change `Boilerplate` (uppercase) to be the human readable name of your plugin.
You're all set! Go make your plugin and write some tests!
## 📓 Tutorials
This repository has been made alongside an article series called **"Automated Testing for Strapi v5 Plugins"**.
To better understand how and why this repository has been setup, please read the following articles:
1. [Using a Playground Instance](https://www.pluginpal.io/automated-testing-for-strapi-plugins-using-a-playground-instance)
2. [Testing the API's](https://www.pluginpal.io/automated-testing-for-strapi-v-5-plugins-testing-the-apis)
3. E2E tests (In Progress)
## 🔌 Commands
### Strapi Plugin SDK commands
1. `yarn build`
- The native build command of `@strapi/sdk-plugin`.
- [Documentation can be found here](https://docs.strapi.io/dev-docs/plugins/development/plugin-sdk).
2. `yarn watch`
- The native watch command of `@strapi/sdk-plugin`.
- [Documentation can be found here](https://docs.strapi.io/dev-docs/plugins/development/plugin-sdk).
3. `yarn watch:link`
- The native watch:link command of `@strapi/sdk-plugin`.
- [Documentation can be found here](https://docs.strapi.io/dev-docs/plugins/development/plugin-sdk).
4. `yarn verify`
- The native verify command of `@strapi/sdk-plugin`.
- [Documentation can be found here](https://docs.strapi.io/dev-docs/plugins/development/plugin-sdk).
- Used in the lint step of the pipeline.
### Testing commands
5. `yarn test:ts:front`
- A check for Typescript errors on the front-end side.
- Used in the lint step of the pipeline.
6. `yarn test:ts:back`
- A check for Typescript errors on the back-end side.
- Used in the lint step of the pipeline.
7. `yarn test:jest`
- Runs the jest tests. Can contain unit & integration tests.
- Used in the test step of the pipeline.
8. `yarn test:cypress`
- Runs the cypress tests. Contains e2e tests.
- Used in the test step of the pipeline.
9. `yarn test:cypress:open`
- Opens the cypress GUI.
### Playground commands
10. `yarn playground:install`
- Installs the plugin into the playground using `yalc-add-link`.
- Installs all other dependencies of the playground.
11. `yarn playground:yalc-add`
- Installs a production-like version of the plugin, into the playground.
12. `yarn playground:yalc-add-link`
- Installs a development build of the plugin, into the playground.
13. `yarn playground:build`
- The native Strapi build command, ran in the playground.
- [Documentation can be found here](https://docs.strapi.io/dev-docs/cli).
14. `yarn playground:develop`
- The native Strapi develop command, ran in the playground.
- [Documentation can be found here](https://docs.strapi.io/dev-docs/cli).
15. `yarn playground:start`
- The native Strapi start command, ran in the playground.
- [Documentation can be found here](https://docs.strapi.io/dev-docs/cli).