Introduction to the Bring Your Own (BYO) Framework

Overview

The BYO (Bring Your Own) framework empowers Creators Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform. to extend the Unqork platform with custom-built functionality that goes beyond Unqork's standard configuration. By packaging and deploying custom component logic in a structured, validated format, developers gain full control over application behavior, while maintaining compatibility with Unqork’s runtime.

The Bring Your Own framework is intended for developers who have a strong understanding of the Unqork Designer Platform and JavaScript JavaScript is an object-oriented computer programming language. It is most-commonly used for interactive effects in the browser..

Understanding the BYO End-to-End Flow

The BYO end-to-end process begins by creating a package archive that includes the implementation (.js) and manifest.json files, which define the metadata and configuration contracts.

After installing a package in your Unqork environment, the Unqork Designer Platform performs validation to ensure the structure and contents are valid. After validation, the package is extracted and its files are uploaded to Unqork's object storage solution (Amazon S3). Then, the package is served through Unqork's CDN (Content Delivery Network), making them accessible to browser-based applications.

Next, the Unqork platform parses the manifest.json to extract metadata used in the display and configuration of custom components in the Designer platform's visual interface.

At runtime, during the initial page load of the application, all JavaScript JavaScript is an object-oriented computer programming language. It is most-commonly used for interactive effects in the browser. files from the package load. Doing so ensures the custom functionality is available and ready to render as part of the application configuration.

Get Started

Use the links below to learn how the BYO framework functions, including:

How to extend the Unqork platform using custom BYO packages.
The required structure and contents of a valid BYO package, including manifest.json and compiled JavaScript.
A working knowledge of the Runtime Engine API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. and how your component interacts with state and events.
How to create, configure, and register custom components for use in the Unqork Designer.
End-to-end visibility into the BYO life cycle—from development to deployment in a live application.