Get Roadie in your IDE with our new MCP Servers
Roadie
← Backstage Plugins Guides
Shortcut logo

Backstage Shortcut Plugin

Created by Roadie

Stories overview in Shortcut plugin.

Installation Instructions

These instructions apply to self-hosted Backstage only. To use this plugin on Roadie, visit the docs.

Install the plugin into Backstage.

Copy 
// packages/app
'yarn add @roadiehq/backstage-plugin-shortcut'

Add proxy configurations

Copy 
// app-config.yaml
proxy:
  # ...
  '/shortcut/api':
    target: https://api.app.shortcut.com/api/v3
    headers:
    Shortcut-Token: '${SHORTCUT_API_TOKEN}'

Add Shortcut stories card to Home page:.

Copy 
// packages/app/src/components/home/HomePage.tsx
import { HomepageStoriesCard } from '@roadiehq/backstage-plugin-shortcut'
// ...

const HomePage = () => {
  <PageWithHeader title="Home" themeId="home">
    <Content>
      ...
        <Grid item md={6} xs={12}>
          <HomepageStoriesCard />
        </Grid>
      ...
     </Content>
  </PageWithHeader>
)

Run the backstage app with the following command and navigate to the user entity.

Copy 
yarn start

Things to Know

Authentication

The Shortcut API uses token-based authentication so in order to retrieve results you will need it. To generate an API token, go to https://app.shortcut.com/settings/account/api-tokens.

API Rate Limit in Shortcut

The Shortcut REST API limits requests to 200 per minute. Any requests over that limit will not be processed, and will return a 429 (“Too Many Requests”) response code.

Changelog

This changelog is produced from commits made to the Shortcut plugin since a year ago. It may not contain information about all commits. Releases and version bumps are intentionally omitted. This changelog is generated by AI.

Breaking changes

  • Dependency upgrades may require a newer Backstage app version. If your app is on an older Backstage release then upgrade Backstage before updating this plugin

Dependency updates

  • Upgrade to 1 40 #1952 2 months ago
  • Update dependencies for plugins #1821 7 months ago
  • Revert dependency update #1825 7 months ago
  • Update Backstage package versions #1728 10 months ago
  • Update dependencies for plugins #1684 11 months ago

Cleanup

  • Remove unused plugin dependencies #1847 7 months ago

Set up Backstage in minutes with Roadie

Get a demo