Skip to content

Commit 4ca81b0

Browse files
AleksanderBodurridylhunn
authored andcommitted
docs(devtools): update development docs (angular#53948)
These docs are out of date with how we currently build devtools in dev mode and as a browser extension. This commit brings these docs up to date. PR Close angular#53948
1 parent 426bcb9 commit 4ca81b0

File tree

2 files changed

+13
-14
lines changed

2 files changed

+13
-14
lines changed

devtools/DEVELOPING.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,18 @@ To setup your development environment run:
44

55
```
66
git clone git@github.com:angular/angular
7-
cd devtools
87
yarn
98
```
109

1110
To run the extension in development mode run:
1211

1312
```
14-
ng serve
13+
yarn devtools:devserver
14+
```
15+
16+
You can also run a standalone version of the demo app with
17+
```
18+
yarn devtools:devserver:demo-standalone
1519
```
1620

1721
This would start a development server that you can access on <http://localhost:4200>. In development, Angular DevTools uses a "development shell." This is different from "chrome shell" in a way, that it runs the user's app in an iframe. DevTools then communicate with the user's app via message passing.
@@ -21,13 +25,15 @@ This would start a development server that you can access on <http://localhost:4
2125
To build the Angular DevTools Chrome extension run:
2226

2327
```
24-
npm run release
28+
yarn devtools:build:chrome
2529
```
2630

27-
This would output the production assets of the app in `dist/shell-browser`. If you want to build the extension with development settings (i.e., not minified sources), just run:
31+
You can then install the extension from `dist/bin/devtools/projects/shell-browser/src/prodapp` following the guide from [here](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked).
32+
2833

34+
You can also build the extension for Firefox with:
2935
```
30-
ng build shell-browser
36+
yarn devtools:build:firefox
3137
```
3238

33-
Later on, you can install the extension from `dist/shell-browser` following the guide from [here](https://developer.chrome.com/apps/external_extensions).
39+
In Firefox, to load the extension, you can go to the about:debugging page, click the "This Firefox" option and then click the Load Temporary Add-on button. You'll have to select the manifest file in `dist/bin/devtools/projects/shell-browser/src/prodapp` directly.

devtools/README.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,7 @@ Angular DevTools is a browser DevTools extension for debugging and profiling Ang
44

55
## Installing and Running locally
66

7-
To setup your local development environment for Angular DevTools, perform the following steps:
8-
9-
```bash
10-
git clone git://github.com/angular/angular
11-
cd angular
12-
yarn
13-
yarn run devtools:devserver
14-
```
7+
To setup your local development environment for Angular DevTools, see [DEVELOPING.md](./DEVELOPING.md)
158

169
## Publish Angular DevTools
1710

0 commit comments

Comments
 (0)