An open API service indexing awesome lists of open source software.

https://github.com/rh-rahulshetty/krkn-backstage-plugin

Backstage plugin for Krkn-Chaos
https://github.com/rh-rahulshetty/krkn-backstage-plugin

backstage backstage-plugin backstage-plugins plugin rhdh rhdh-poc typescript

Last synced: 12 months ago
JSON representation

Backstage plugin for Krkn-Chaos

Awesome Lists containing this project

README

          

# backstage-plugin-krkn-chaos

This backstage plugin is a Proof Of Concept for bringing [Krkn-Chaos](https://krkn-chaos.dev/) into Backstage and RHDH.

![Demo](./docs/demo.png)

_This plugin was created through the Backstage CLI_

## Installation

**Prerequisites**

Make sure you have a running Backstage or RHDH instance and if you don't have one, then you can setup a basic backstage app by following this [getting started](https://backstage.io/docs/getting-started/) guide.

1. Clone this repository into backstage's plugin directory.
```
# From the root of backstage directory
cd plugins
git clone https://github.com/rh-rahulshetty/krkn-backstage-plugin.git
```

2. Add the package in the `packages/app/package.json`
```
"@internal/backstage-plugin-backstage-plugin-krkn-chaos": "^0.1.0",
```

3. Add Route in `packages/app/src/App.tsx`:

```tsx title="packages/app/src/App.tsx"
/* highlight-add-next-line */
import { BackstagePluginKrknChaosPage } from '@internal/backstage-plugin-backstage-plugin-krkn-chaos';

} />
```

4. Add your plugin as a Sidebar Item in `packages/app/src/components/Root/Root.tsx`:

```tsx title="packages/app/src/components/Root/Root.tsx"
/* highlight-add-next-line */
import CenterFocusStrongIcon from '@material-ui/icons/CenterFocusStrong';

export const Root = ({ children }: PropsWithChildren<{}>) => (


...

...


);
```

6. From the backstage root directory and the plugins directory, run `yarn` command to install any missing NPM dependencies.

7. Start your application from the root directory, and then navigate to [/krkn-chaos](http://localhost:3000/krkn-chaos).