|
1 | 1 | # Frontend |
2 | 2 |
|
3 | 3 | ## tl;dr |
4 | | -``` |
| 4 | + |
| 5 | +```bash |
5 | 6 | yarn install |
| 7 | +# Make sure you have the backend running. |
6 | 8 | yarn dev |
7 | 9 | ``` |
8 | 10 |
|
9 | 11 | ## Overrides |
10 | | -This repository currently uses `grafana/pyroscope` components, which then are overridden as necessary, |
11 | | -using typescript's alias and webpack alias configuration. See `tsconfig.json` and `webpack.common.js` |
| 12 | + |
| 13 | +This repository currently uses [grafana/pyroscope] components, which then are overridden as necessary, |
| 14 | +using typescript's alias and webpack alias configuration. See [tsconfig.json] and [webpack.common.js] |
12 | 15 | for more info. |
13 | 16 |
|
| 17 | +[tsconfig.json]: ../tsconfig.json |
| 18 | +[webpack.common.js]: ../scripts/webpack/webpack.common.js |
14 | 19 |
|
15 | 20 | ### Guidelines for imports |
16 | 21 |
|
17 | 22 | It may be confusing to see different imports, so let's go over the most common examples: |
18 | 23 |
|
19 | | -`@webapp` -> Refers to `pyroscope-oss`, aka `grafana/pyroscope` repo. |
20 | | -`@pyroscope/webapp` -> Refers to `pyroscope-oss`, aka `grafana/pyroscope` repo. |
| 24 | +`@webapp` -> Refers to `pyroscope-oss`, aka [grafana/pyroscope] repo. |
| 25 | +`@pyroscope/webapp` -> Refers to `pyroscope-oss`, aka [grafana/pyroscope] repo. |
21 | 26 | `@phlare` -> Refers to code in this repository. Note that this is needed since other |
22 | 27 | downstream repositories may use this repository, and they also may want to override specific files. |
23 | 28 |
|
24 | | -In the future, once both `grafana/pyroscope` and `grafana/phlare` are merged, there will |
25 | | -be no need for `@webapp` and similar to happen, since there will be no `grafana/pyroscope` repo anymore. |
| 29 | +In the future, once both [grafana/pyroscope] and [grafana/phlare] are merged, there will |
| 30 | +be no need for `@webapp` and similar to happen, since there will be no [grafana/phlare] repo anymore. |
| 31 | + |
| 32 | +[grafana/pyroscope]: https://github.com/grafana/pyroscope |
| 33 | +[grafana/phlare]: https://github.com/grafana/phlare |
0 commit comments