For internal use only. All changes are recorded in the CHANGELOG.md file.
This is a new integration boilerplate for VSF 2 integrations based on the SDK.
- NodeJS v16 or later,
- Yarn.
This repository contains a few necessary packages to help you get started building your new integration:
api-client
- The API Client runs in the middleware and creates a server-to-server connection with service providers (e.g. commerce backend). It contains anexampleEndpoint
with interfaces and unit tests, that can be used as an example for the other API endpoints,sdk
- Think of the SDK Connector as a communication layer between the storefront and the middleware. It contains anexampleMethod
with example documentation, unit & integration tests, that can be used as an example for the rest SDK connector methods.demo
- Demonstrates the usage ofapi-client
by creating an express server app. You can use this directory to demonstrate the usage of the integration.docs
- VuePress documentation with configured API extractor, to create an API Reference based on theapi-client
andsdk
methods & interfaces.
- Use this repository as a template.
- Navigate to
api-client
package and change allboilerplate
occurrences to your integration name, - Navigate to
sdk
package and change allboilerplate
occurrences to your integration name, - Navigate to
docs
package and change allboilerplate
occurrences to your integration name, - Install the dependencies,
yarn
- Build the packages,
yarn build
- Test the packages,
yarn test
- That's it. Now you can start the development,
- Enjoy.