|
| 1 | +# UI Onboarding |
| 2 | + |
| 3 | +This documents contains the onboarding guide for hypertrace-ui. |
| 4 | + |
| 5 | +- [Fork the repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) |
| 6 | +- Tools Setup: |
| 7 | + - [Node and Npm](https://www.npmjs.com/get-npm) |
| 8 | +- Techologies Used |
| 9 | + 1. [Angular](https://angular.io/docs) |
| 10 | + 2. [Typescript 4.x](https://www.typescriptlang.org/docs/) |
| 11 | + 3. [Angular Testing with Spectator](https://github.com/ngneat/spectator) |
| 12 | + - Policy around testing. |
| 13 | + - Unit tests: Component test and service test |
| 14 | + - Shallow test |
| 15 | + - CodeCov requirements |
| 16 | + - Tools used: |
| 17 | + Jest, vscode-jest and wallabyjs |
| 18 | + 4. [Rxjs](https://rxjs.dev/guide/overview/) |
| 19 | + 5. [D3Js](https://github.com/d3/d3/wiki) |
| 20 | +- Libraries Used |
| 21 | + |
| 22 | + - [Hyperdash](https://github.com/hypertrace/hyperdash/blob/main/README.md) |
| 23 | + - [Hyperdash angular](https://github.com/hypertrace/hyperdash-angular/blob/main/README.md) |
| 24 | + - [Assets-Library](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/assets-library) |
| 25 | + - [Common](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/common) |
| 26 | + - [Components](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/components) |
| 27 | + - [Dashboards](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/dashboards) |
| 28 | + - [Distributed Tracing](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/distributed-tracing) |
| 29 | + - [Observability](https://github.com/hypertrace/hypertrace-ui/tree/main/projects/observability) |
| 30 | + |
| 31 | +- [Hypertrace ui app](https://github.com/hypertrace/hypertrace-ui/tree/main/src) |
| 32 | +- Hyperdash and writing config driven UI |
| 33 | + |
| 34 | +[^1]: More to be added soon. |
0 commit comments