Skip to content

drsounds/backstage-plugin-stitch-apps

Repository files navigation

Backstage Stitch Apps Plugin

Warning

Work in Progress: This plugin is currently under active development. Features and APIs are subject to change.

This project contains Backstage plugins (frontend and backend) that provide the capability to embed HTML5 "stitch" applications directly within a Backstage instance. It is designed to facilitate seamless integration between Backstage and third-party solutions.

Structure

  • backstage-plugin-stitch-apps-frontend: The frontend plugin that renders the embedded applications.
  • backstage-plugin-stitch-apps-backend: The backend plugin that manages the app configurations and serving.

Features

  • Embed HTML5 Apps: Easily host and display external HTML5 applications within the Backstage UI.
  • Third-Party Integration: Bridge the gap between Backstage and external tools or services.
  • Bi-directional Communication: Enables communication between the embedded app and Backstage using window.postMessage, allowing for rich interactions and data exchange.

Roadmap

To do: 🔲 Origin checks 🔲 Communicate with Backstage over postMessage (subject to security). For example, on initial load, post a token with info about the user so the client app can communicate with Backstage. 🔲 CSP adjustment on the instance

Communication

The plugin supports a communication protocol based on window.postMessage. This allows the embedded "stitch" app to send messages to the Backstage host and receive responses, enabling tight integration with Backstage's context and APIs.

License

This project is licensed under the MIT License - see the LICENSE file for details.

See live recording of the development process

https://www.youtube.com/live/-LHUrh2kAng (Part 1) https://www.youtube.com/live/wpUqxHKq5wE (Part 2)

About

Allow integrating external HTML5 apps with Backstage

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors