README.md

Vendure plugin template

1. Copy this directory and rename to vendure-plugin-YOUR-PLUGIN-NAME
2. Update the name and description field in package.json
3. Update this Readme: What does the plugin do? How can someone use your plugin in their project?
4. Run yarn to install the dependencies
5. Run yarn start to 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

1. Run yarn test to run the e2e test.
2. Don't forget to implement your own!

Publishing to NPM

1. Make sure you are logged in to NPM
2. yarn build
3. yarn publish

That's it!

(Maybe share your accomplishments in the Vendure slack?

Next steps

1. Check out the docs to see the possibilities of a plugin
2. Check out GraphQL codegen to generate Typescript types for your custom GraphQL types