paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 33 Packages Projects Releases Wiki Activity

Merge pull request #1124 from spotify/freben-patch-2

Browse Source 
Update development-environment.md
This commit is contained in:
Patrik Oldsberg
2020-06-03 11:15:45 +02:00
committed by GitHub
parent 3276db8716 e02a2d1e56
commit a604e62a55
1 changed files with 16 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/getting-started/development-environment.md
+16 -4
View File
@@ -1,16 +1,28 @@
# Development Environment
This section describes how to get set up for doing development on the Backstage repository.
## Cloning the Repository
After you have cloned the Backstage repository, you should run the following commands
once to set things up for development:
```bash
$ yarn install # fetch dependency packages - may take a while
$ yarn tsc # does a first run of type generation and checks
```
## Serving the Example App
Open a terminal window and start the web app using the following commands from the project root:
Open a terminal window and start the web app by using the following command from the project root.
Make sure you have run the above mentioned commands first.
```bash
$ 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.
This 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`.