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

update docs to match new build script + fixes

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2022-11-15 11:04:19 +01:00
parent 657b0da3c7
commit 5e7bdb0109
15 changed files with 36 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/getting-started/contributors.md
+2 -1
View File
@@ -101,7 +101,8 @@ yarn workspace @backstage/plugin-api-docs start # Serve api-docs plugin only, al
yarn tsc # Run typecheck, use --watch for watch mode
yarn tsc:full # Run full type checking, for example without skipLibCheck, use in CI
yarn build # Build published versions of packages, depends on tsc
yarn build:backend # Build the backend package, depends on tsc
yarn build:all # Build published versions of packages, depends on tsc
yarn lint # lint packages that have changed since later commit on origin/master
yarn lint:all # lint all packages
docs/getting-started/running-backstage-locally.md
+12 -21
View File
@@ -41,47 +41,38 @@ locally to use features like Software Templates and TechDocs. Please refer to
the
[installation instructions for Docker](https://docs.docker.com/engine/install/).
## Clone and Build
## Clone and Install
To get up and running with a local Backstage to evaluate it, let's clone it off
of GitHub and run an initial build.
of GitHub and run an initial install.
```bash
# Start from your local development folder
git clone --depth 1 git@github.com:backstage/backstage.git
cd backstage
# Fetch our dependencies and run an initial build
# Install our dependencies
yarn install
yarn tsc
yarn build
```
Phew! Now you have a local repository that's ready to run and to add any open
source contributions into.
We are now going to launch two things: an example Backstage frontend app, and an
example Backstage backend that the frontend talks to. You are going to need two
terminal windows, both starting from the Backstage project root.
In the first window, run
example Backstage backend that the frontend talks to. These can both be launched
through the following command:
```bash
# From your Backstage root directory
yarn --cwd packages/backend start
# From your Backstage root directory, launches both the frontend and backend
yarn dev
```
That starts up a backend instance on port 7007.
If you prefer to run the frontend and backend separately, you can instead use `yarn start`
and `yarn start-backend` in two separate terminal windows.
In the other window, we will then launch the frontend. This command is run from
the project root, not inside the backend directory.
```bash
yarn start
```
That starts up the frontend on port 3000, and should automatically open a
browser window showing it.
Which ever way you choose, you will now have a backend instance running on port 7007,
and the frontend running on port 3000. A browser window should also automatically open,
showing the frontend.
## Authentication