Contributing

Git Branch Workflow

This project adheres to GitHub Flow.

Development (Not for customers)

Requirements

Node.js 18.0 or newer
NPM 10.0 or newer

Running Locally

This code base is written in TypeScript so it cannot be included locally in an application without a build step. Luckily, we have provided one :)

Allow NPM package to be linked
```
npm link
```
Start the watch process for building the code when changes occur
```
npm start
```
In your application, link to this package instead of a version on NPM
```
npm link @oneblink/storage
```

Release Process

Checkout master
```
git checkout master
```
Get the latest code
```
git pull
```
Start the release process
```
npm run release
```