xref: /aosp_15_r20/external/pigweed/pw_web/log-viewer/README.md (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker# Log Viewer
2*61c4878aSAndroid Build Coastguard Worker
3*61c4878aSAndroid Build Coastguard WorkerAn embeddable log-viewing web component that is customizable and extensible for use in various developer contexts.
4*61c4878aSAndroid Build Coastguard Worker
5*61c4878aSAndroid Build Coastguard Worker## Installation
6*61c4878aSAndroid Build Coastguard Worker
7*61c4878aSAndroid Build Coastguard Worker1. Clone the main Pigweed repository:
8*61c4878aSAndroid Build Coastguard Worker
9*61c4878aSAndroid Build Coastguard Worker```
10*61c4878aSAndroid Build Coastguard Workergit clone https://pigweed.googlesource.com/pigweed/pigweed
11*61c4878aSAndroid Build Coastguard Worker```
12*61c4878aSAndroid Build Coastguard Worker
13*61c4878aSAndroid Build Coastguard Worker2. Navigate to the project directory:
14*61c4878aSAndroid Build Coastguard Worker
15*61c4878aSAndroid Build Coastguard Worker```
16*61c4878aSAndroid Build Coastguard Workercd pigweed
17*61c4878aSAndroid Build Coastguard Worker```
18*61c4878aSAndroid Build Coastguard Worker
19*61c4878aSAndroid Build Coastguard Worker3. Install the necessary dependencies:
20*61c4878aSAndroid Build Coastguard Worker
21*61c4878aSAndroid Build Coastguard Worker```
22*61c4878aSAndroid Build Coastguard Workersource bootstrap.sh
23*61c4878aSAndroid Build Coastguard Worker```
24*61c4878aSAndroid Build Coastguard Worker
25*61c4878aSAndroid Build Coastguard Worker## Build
26*61c4878aSAndroid Build Coastguard Worker
27*61c4878aSAndroid Build Coastguard Worker1. Navigate to the project directory:
28*61c4878aSAndroid Build Coastguard Worker
29*61c4878aSAndroid Build Coastguard Worker```
30*61c4878aSAndroid Build Coastguard Workercd pigweed/pigweed_web/log-viewer
31*61c4878aSAndroid Build Coastguard Worker```
32*61c4878aSAndroid Build Coastguard Worker
33*61c4878aSAndroid Build Coastguard Worker
34*61c4878aSAndroid Build Coastguard Worker2. run the following command at the root of the project:
35*61c4878aSAndroid Build Coastguard Worker
36*61c4878aSAndroid Build Coastguard Worker```
37*61c4878aSAndroid Build Coastguard Workernpm run build
38*61c4878aSAndroid Build Coastguard Worker```
39*61c4878aSAndroid Build Coastguard Worker
40*61c4878aSAndroid Build Coastguard WorkerThis will generate the compiled files used in the application.
41*61c4878aSAndroid Build Coastguard Worker
42*61c4878aSAndroid Build Coastguard Worker## Development Mode
43*61c4878aSAndroid Build Coastguard Worker
44*61c4878aSAndroid Build Coastguard WorkerTo run the application in development mode, use the following command:
45*61c4878aSAndroid Build Coastguard Worker
46*61c4878aSAndroid Build Coastguard Worker```
47*61c4878aSAndroid Build Coastguard Workernpm run dev -- --host
48*61c4878aSAndroid Build Coastguard Worker```
49*61c4878aSAndroid Build Coastguard Worker
50*61c4878aSAndroid Build Coastguard WorkerThis will start the development server and launch the application. The `--host` flag is optional and can be used to specify the host address.
51*61c4878aSAndroid Build Coastguard Worker
52*61c4878aSAndroid Build Coastguard Worker## Usage