Backstage

What is Backstage?

Backstage is an open platform for building developer portals.

Getting started

Protobuf Definitions

To generate the Protobuf definitions in Go and TypeScript, run the following command from the root with Prototool:

$ prototool generate ./proto

See proto/README.md for more information.

Plugins

Creating a Plugin

Run the following:

$ ./tools/cookiecutter/init.sh frontend/packages/plugins/_template --output-dir frontend/packages/plugins

This will generate a plugin in the frontend/packages/plugins folder. It is important to note you will still need to include the plugin in your frontend/packages/app in the package.json. You will then be able to import it as follows:

$ ./tools/cookiecutter/init.sh frontend/packages/plugins/_template --output-dir frontend/packages/plugins
plugin_name [example-plugin]: github-api

$ vim frontend/packages/app/package.json
# Add the following line to your package.json
# Note all plugins are prefixed with "plugin-" by default with a version number of "0.0.0"
# "@backstage/plugin-github-api": "0.0.0",

$ vim frontend/packages/app/src/App.tsx
# Add the following line to import your generated component
# import { ExampleComponent } from '@backstage/plugin-github-api';
# <ExampleComponent />

Documentation

License

Copyright 2020 Spotify AB.

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0