@filestack/canvas-sdk

Filestack Canvas SDK(ES6Compatible)

Table of Contents

• What's in the box?
• Installation
• Linking on local
• NPM Commands
• Versioning
• Contributing

What's in the box?

• Filestack Canvas library for managing image transformation build on top of fabric-js

Installation

To install library you need to access to this repo over ssh/https

Paste in package.json

"@filestack/canvas-sdk" : "*",

Linking on local

Run command on filestack-canvas folder:

  npm link

Run command on your project folder:

 npm link @filestack/canvas-sdk

NPM Commands

info - Display information about the package scripts
build - Clean and rebuild the project
fix - Try to automatically fix any linting problems
test - Lint and unit test the project
watch - Watch and rebuild the project on save, then rerun relevant tests
cov - Rebuild, run tests, then create and open the coverage report
doc - Generate HTML API documentation and open it in a browser
doc:publish - Generate docs and publish it to gh-pages
release - Bump package.json version, update CHANGELOG.md, tag release
prepare-release - One-step - clean, build, test, publish docs, and prep a release
install - Build needed fabric modules

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Contributing

We follow the conventional commits specification to ensure consistent commit messages and changelog formatting.