https://github.com/thefrontside/playhouse

Frontside's Backstage Portal
https://github.com/thefrontside/playhouse

backstage

Last synced: 7 days ago
JSON representation

Frontside's Backstage Portal

• Host: GitHub
• URL: https://github.com/thefrontside/playhouse
• Owner: thefrontside
• Created: 2021-12-16T13:00:17.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-11T11:41:45.000Z (about 1 month ago)
• Last Synced: 2024-10-12T05:29:28.291Z (about 1 month ago)
• Topics: backstage
• Language: TypeScript
• Homepage: https://backstage.frontside.services/
• Size: 133 MB
• Stars: 25
• Watchers: 12
• Forks: 13
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
## Backstage

To start the Backstage app with Postgres via docker compose, run:

```sh

docker-compose up

yarn install

yarn dev

```

## Running with simulation

We're using the [Auth0 Simulator](https://www.npmjs.com/package/@simulacrum/auth0-simulator) for local development.

It's automatically started by `yarn dev`.

Keep an eye for user information in the log output.

![Log output with user information](https://user-images.githubusercontent.com/74687/199505266-1519969d-d5b3-4f4a-93a0-943b47d0d13b.jpg)

## Running with production config

Running with simulation should be used in most situations. However, there are times where using the production config is necessary to debug, e.g. specific Auth0 configuration issues.

With access to the Frontside 1Password vault and the [1Password CLI](https://developer.1password.com/docs/cli/), you may inject the secrets into a `.gitignore`d config file and use the `yarn dev:config` command to pick up these values.

```

op inject -i app-config.1password.yaml.tpl -o app-config-credentials.yaml

```

## Running in minikube

```

TAG=whatever

yarn install

yarn tsc

yarn build

yarn build-image --tag backstage:$TAG

minikube start

eval $(minikube docker-env)

minikube image load backstage:$TAG

# TODO - need to modify the charts so that the following steps are automated but for now please do the following:

* 💥 comment out ./backstate/templates/certificate.yaml

* 💥 move ./backstage/templates/secrets.yaml to another directory

* 💥 comment out `volumeMounts` and `volumes`

* 💥 modify container command to exclude `app-config.production.yaml`

PG=whatever

helm upgrade --install min-postgres-chart ./charts/postgres \

  -f ./charts/postgres/Values.yaml \

  --set postgresUsername=$PG \

  --set postgresPassword=$PG

POSTGRES_SERVICE_PORT=5432 POSTGRES_USER=$PG POSTGRES_PASSWORD=$PG helm upgrade --install min-backstage-chart ./charts/backstage \

  -f ./charts/backstage/Values.yaml \

  --set backstageImage=backstage:$TAG \

  --set baseUrl=http://localhost:7007

kubectl port-forward svc/backstage 7007:80

```