Files
backstage/docs/getting-started/development-environment.md
T
Ahmet Soormally 9235807f14 document how to override the default port
Port 3000 is a common port in the development environment.

This documents how you can start backstage with a different port to the default.

Moved section for development environment to own page within docs in order to keep README small.
2020-03-29 21:59:46 +01:00

1.0 KiB

Development Environment

Open a terminal window and start the web app using the following commands from the project root:

$ yarn install # may take a while

$ yarn start

The final yarn start command should open a local instance of Backstage in your browser, otherwise open one of the URLs printed in the terminal.

By default, backstage will start on port 3000, however you can override this by setting an environment variable PORT on your local machine. e.g. export PORT=8080 then running yarn start. Or PORT=8080 yarn start.

Once successfully started, you should see the following message in your terminal window:

You can now view @backstage/app in the browser.

  Local:            http://localhost:8080
  On Your Network:  http://192.168.1.224:8080

(Optional)Try on Docker

Run the following commands if you have Docker environment

$ docker build . -t spotify/backstage
$ docker run --rm -it -p 80:80 spotify/backstage

Then open http://localhost/ on your browser.

Back to Docs