plugin-template
plugin-template copied to clipboard
A template for creating re-usable Vendure plugins
Vendure plugin template
- Copy this directory and rename to
vendure-plugin-YOUR-PLUGIN-NAME - Update the
nameanddescriptionfield inpackage.json - Update this Readme: What does the plugin do? How can someone use your plugin in their project?
- Run
yarnto install the dependencies - Run
yarn startto start the server
The admin is now available at http://localhost:3050/admin. Login with superadmin/superadmin
The shop GraphQL http://localhost:3050/shop-api. Here you can test your custom GraphQL query:
{
exampleQuery
}
Testing
- Run
yarn testto run the e2e test. - Don't forget to implement your own!
Publishing to NPM
- Make sure you are logged in to NPM
yarn buildyarn publish
That's it!
(Maybe share your accomplishments in the Vendure slack?
Next steps
- Check out the docs to see the possibilities of a plugin
- Check out GraphQL codegen to generate Typescript types for your custom GraphQL types