README.md

Backstage

Requirements

• Node 16
• Yarn
• Docker / Docker Compose

Build and running

• Create a new OAuth App in your GitHub developer settings: https://github.com/settings/developers

Name: Backstage
Homepage URL: http://localhost:7007
Authorization callback URL: http://localhost:7007/api/auth/github/handler/frame

• Copy your GitHub Client ID and Secret, and use as following:

yarn install --frozen-lockfile
yarn tsc
yarn build
docker compose build
BS_CLIENT_ID="your GitHub client ID" BS_CLIENT_SECRET="your GitHub secret" docker compose up

Open Chrome on http://localhost:7007

Develop

yarn install
yarn dev

UI

Home page

Catalog

Tech docs

Custom software templates

Github integration