Appointedd Booking Tools SDK

This repository hosts the public source development kit (SDK) that allows Appointedd's clients to programmatically integrate our booking tools with their website and interact with it via page scripts.

This SDK only supports our modern booking tools (referred to in the software as Widgets 2.0) and not our legacy booking tools (referred to in the software as Legacy Widgets).

| Component | Description | | ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Booking Tool SDK | Provides an API for integrating and interacting with our booking tools. | | Location Search | Provides a consumable component that allows a user to input location and preferred date & time preferences before beginning the booking journey with our booking tools. |

Development

This project supports volta which allows you to automatically use the correct node.js and pnpm versions without any additional configuration.

Installing Dependencies

We use pnpm to manage our dependencies. If you already have volta setup you can simply run the following command in a terminal with the root of this project open.

If you run into issues with the pnpm command not existing, ensure you've correctly reinstalled volta. Alternatively you can also try running volta install pnpm.

pnpm install

SDK Bundle Development

If you're developing applications and services that require the SDK bundle to be served locally, you can run the command below in a terminal at the root of the project.

pnpm dev

A local version of the bundle will be served be accessible at http://localhost:9002/appointedd-booking-tools-sdk-v1.js.

Running Storybook

To view a live preview of the React components we export you can run Storybook in your terminal at the root of this project.

pnpm run storybook

Versioning Strategy

Our general policy is to avoid breaking changes as much as possible and only implement these if absolutely required.

NPM Package

This project uses semantic versioning which is automatically enforced by a combination of using conventional commits with semantic release to automatically run package deployments on push/merge to our main branch. The version bump of the package utilises the commits to calculate whether to bump the version of the package by a major/minor/patch version.

Because of this please familiarise yourself with the conventional commits and ensure that your commits are correctly encapsulated as deployments and version bumps will not trigger correctly if you do not follow this specification.

Components

We also make use of folder level major versioning (eg. V1/, V2/), at the component level. If you need to implement a breaking change you MUST create a new folder level version.

Versions should be isolated and independent of each other and should not import the same code. Any version below the latest major version should be considered deprecated and a deprecation warning in the form of a console message should be implemented.