rohrig / sdk-next

SDK Based Integration Boilerplate for VSF 2

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.

Requirements:

• NodeJS v16 or later,
• Yarn.

Repository structure

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 an exampleEndpoint 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 an exampleMethod with example documentation, unit & integration tests, that can be used as an example for the rest SDK connector methods.
• demo - Demonstrates the usage of api-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 the api-client and sdk methods & interfaces.

Getting started

1. Use this repository as a template.
2. Navigate to api-client package and change all boilerplate occurrences to your integration name,
3. Navigate to sdk package and change all boilerplate occurrences to your integration name,
4. Navigate to docs package and change all boilerplate occurrences to your integration name,
5. Install the dependencies,

yarn

5. Build the packages,

yarn build

6. Test the packages,

yarn test

7. That's it. Now you can start the development,
8. Enjoy.