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

docs: format with prettier (#1218)

Browse Source
This commit is contained in:
Patrik Oldsberg
2020-06-09 19:50:41 +02:00
committed by GitHub
parent 4f3375073d
commit a633dce818
20 changed files with 756 additions and 364 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/getting-started/development-environment.md
+20 -10
View File
@@ -1,11 +1,12 @@
# Development Environment
This section describes how to get set up for doing development on the Backstage repository.
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:
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
@@ -15,18 +16,22 @@ $ yarn tsc # does a first run of type generation and checks
## Serving the Example App
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.
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 start
```
This 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`.
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:
Once successfully started, you should see the following message in your terminal
window:
```
You can now view example-app in the browser.
@@ -37,11 +42,16 @@ You can now view example-app in the browser.
## Editor
The Backstage development environment does not require any specific editor, but it is intended to be used with one that has built-in linting and type-checking. The development server does not include any checks by default, but they can be enabled using the `--check` flag. Note that using the flag may consume more system resources and slow things down.
The Backstage development environment does not require any specific editor, but
it is intended to be used with one that has built-in linting and type-checking.
The development server does not include any checks by default, but they can be
enabled using the `--check` flag. Note that using the flag may consume more
system resources and slow things down.
## Package Scripts
There are many commands to be found in the root [package.json](package.json), here are some useful ones:
There are many commands to be found in the root [package.json](package.json),
here are some useful ones:
```python
yarn start # Start serving the example app, use --check to include type checks and linting