@waoadb/react-sdk NPM

Different Breed ® - React SDK

💡 This package is intended to be installed and not edited directly. We simply offer the source code to provide transparency around what is happening under the hood. If you require changes or additional features please raise an issue within Github.

Overview

The following package serves as a software development kit to speed up and simplify the integration of your React / Next.js project with the Different Breed Client API’s.

Quick Start

Install the application using your favourite package manager.

npm install @waoadb/react-sdk

yarn add @waoadb/react-sdk

Documentation

All documentation for Open Source Different Breed ® packages can be found here: Documentation. For the React SDK, please see the following link: React SDK.

Local Development

💡 These instructions are intended for the Different Breed Team, If you require changes or additional features please raise an issue within Github.

Linking

The parent repo housing this component is a Mono repo powered by Lerna. To use this package locally in a theme, simply add the following code to your package.json file and run yarn to link the package.

"@waoadb/react-sdk": "*",

Active Changes

To make active changes in a mock environment before building, Simply run the storybook instance set up for our packages. This can be done by running the following command:

yarn dev:storybook-packages

This will spin up an associated storybook linked to all open source packages within the repo.

Build

When running the plugin with our theme, We ideally do not want to run watch tasks for each package being used as this lead to additional RAM being used. For the purposes of editing packages we ideally want to use the storybook instance to test changes then initiate a build to pull those changes into the project we are working on.

To build a package, run the following command:

yarn packages:build

Publishing

Package publishing is powered by Lerna versions and can be run using the following command.

yarn packages:publish

This will perform the following: Build the package, increase the version and then release the package to NPM. It is worth noting that only team accounts may publish to the NPM organisation. Please contact your team lead for these permissions.

Contributing

The main purpose of this repository is to continue evolving Different Breed ®'s open source work, making it faster and easier to use. Development of Different Breed packages and themes happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Different Breed ® Open Source.