Skip to content

setting-up.md

Latest commit

 

History

History
47 lines (31 loc) · 1.21 KB

setting-up.md

File metadata and controls

47 lines (31 loc) · 1.21 KB

Setting up

Install all the dependencies.

yarn install

Build the entire plugin ecosystem.

yarn build

Before starting the Backstage instance make sure you have the correct environment variables set for testing.

export PAGERDUTY_CLIENT_ID=<your_oauth_2_client_id>
export PAGERDUTY_CLIENT_SECRET=<your_oauth_2_client_secret>
export PAGERDUTY_SUBDOMAIN=<your_pd_subdomain>

Also, you should update your examples/entities.yaml file to use your own service ID.

Then, run the backstage instance.

yarn start

Running single plugins

If instead of running the entire project you just want to run a specific plugin you can simply run:

yarn --cwd plugins/<name-of-the-plugin> start

This will provide you hot reload, which makes developing more comfortable.

Portal Studio

Sometimes we may want to test our changes in a Portal environment, which is not feasable locally due to lack of a Portal image. Nonetheless, the Spotify developed the Portal Studio which allows us to test directly in a real Portal instance. Running the following command mirrors your local development into your real instance:

yarn studio:start --instance <the-subdomain-of-your-instance>