@jphil/bookwhen-client NPM

`@jphil/bookwhen-client`

[wip]!

An API client library for the Bookwhen booking platform API (v2), written in Typescript for NodeJS. Intended for server-side environments.

Overview

You'll likely be at least somewhat familiar with the Bookwhen booking platform if you've landed here. But if not, you'll want to have a look at their API (v2) documentation. There's also a nice Swagger style layout of the Bookwhen API v2 docs

Features

Lightweight and easy to integrate
Fully typed for TypeScript support

Installation

Install via pnpm:

pnpm add @jphil/bookwhen-client

Usage

[wip]!

// ... todo

Configuration

Required configuration options:

apiKey: Your Bookwhen API key (required)

API requests to the Bookwhen API are authenticated using Basic Authentication with the API Key as the username and a blank password.

API keys can be generated in the API tokens setup area of your Bookwhen account.

Contributing

How to Contribute

Thank you for your interest in contributing!

This library follows the standard Github Flow contribution workflow, have a read of the guide to Github Flow from the Github docs, if you're not familiar.

Contribution Requirements

Use the conventional commits style when writing your commit messages.
Ensure you create a changeset as the final commit before creating a new PR (or updating one).

Setting Up Husky for Contributions

This project uses Husky for Git hooks and Commitlint to enforce commit message standards.

Install Dependencies: First, clone the repository and install the project dependencies, which include Husky:

git clone <repository-url>
cd <repository-directory>
pnpm install

Activate Husky Hooks: After installing dependencies, you need to initialize Husky's Git hooks. Run the following command:

pnpm husky install

This command sets up a .husky/ directory in the project, linking the necessary scripts to Git’s hook system. Once activated, Husky will automatically enforce commit message standards during commits.

Thank you for helping maintain commit quality and consistency!

[wip]!

CI

consider changesets in the following?

Contrib flow

Contrib user clones repo locally
Contrib user creates a feature branch
Contrib user generates commits to feature branch
Contrib user create a PR back to the origin/default branch
CI pipeline activates and runs at least tests && build -> On success PR can be merged to main by Maintainer -> On fail PR needs updating until tests and build success