Home

Purpose of katapult-pro-extended

This repository is a collaboration space for our NPM API package @katapult-engineering/api-extensions. The repository includes style and element files for use in creating Katapult-like websites to extend the Katapult-Pro platform. Included is a webpage quickstart element (our <katapult-page-element>), as well as API-enabled elements. Elements in this package build off of the elements in the katapult-pro-elements repository (which is published to NPM as @katapult-engineering/elements.

Who is the user?

This repository is built specifically for clients who use our API. None of the work here is meant to be used internally, and any elements that are built incidentally through creating new functionality should be put in the katapult-pro-elements repository. We hope to save clients time by giving them helpful scripts, styles, and elements to make it easier for them to create their own functionality with their Katapult data. Consider how much easier it is to get information when we internally have functions such as PickAnAttribute() or DataViews.

What are the development principles for this repository?

Since this repository is for external use and is public, no sensitive Katapult information should be included in commits. When building components out, files should be kept modular and be split into different locations when they might be reused. If something already exists in photoheight and is being duplicated, consider if those files should be split into their own repository, or if they would better serve us and our clients by being a part of a separate package (a script/function package for example). Avoid duplication with photoheight if at all possible.