Backstage

Backstage - IDP

Environments you need before start

Name	Where to get?
GITHUB_ACCESS_TOKEN	Generate a new personal access token in GIthub Secure page
AUTH_GITHUB_CLIENT_ID	Get in Github app ID
AUTH_GITHUB_CLIENT_SECRET	Open a tiket to Devxp to share this value
SONARQUBE_TOKEN	Create a Sonarqube token using this documentation

All environments above MUST be exported in your bash context like below:

# .bashrc or .zshrc
export GITHUB_ACCESS_TOKEN='YOUR-TOKEN-HERE'
export AUTH_GITHUB_CLIENT_ID='YOUR-TOKEN-HERE'
export AUTH_GITHUB_CLIENT_SECRET='YOUR-TOKEN-HERE'
export SONARQUBE_TOKEN='YOUR-TOKEN-HERE'

Setup your hosts

You'll need to create an entry to your /etc/hosts to specify backstage.local like below:

# /etc/hosts

# ...
127.0.0.1 backstage.local
#...

Start project

You'll need Docker and docker-compose installed before you continue!

Once all you need is in your bash context, just run the commands below:

docker-compose run --rm app yarn # to install node_modules
docker-compose up -d app # to up the backstage application

Backstage in develop mode will be available in http://backstage.local:3000 and it's using GitHub SSO integration

✨ Contributions

We ❤️ contributions big or small. See our guide on how to get started.

Thanks to all our contributors!