README.md
1<p align="center">
2 <img width="200" src="https://open-wc.org/hero.png"></img>
3</p>
4
5## netsim web UI
6
7This directory contains the Web UI for netsim.
8
9## Prerequisite
10
11The netsimd web server must be up and running.
12
13## Build Commands
14
15Firstly, you must enter the ui directory and run npm install.
16
17```sh
18cd $REPO/tools/netsim/ui
19npm install
20```
21
22Command for compiling and building web UI:
23
24```sh
25npm run build
26```
27
28Command for translating netsim's model.proto into model.ts:
29
30```sh
31npm run tsproto
32```
33
34Command for running local web development server:
35
36```sh
37npm start
38```
39
40Local web server will be served in `http://localhost:8000/web/`
41
42## Scripts
43
44- `build` compiles TypeScript into JavaScript and bundle to distribution with rollup
45- `tsproto` translates netsim's model.proto into model.ts
46- `start` runs your app for development, reloading on file changes
47
48## Tooling configs
49
50- `package.json` contains all npm packages and scripts for web development
51- `rollup.config.mjs` applies import mappings to CDNs and bundles to distribution
52- `tsconfig.json` has configurations for typescript compiling.
53
54## Authors
55
56[Hyun Jae Moon] hyunjaemoon@google.com
57
58[Bill Schilit] schilit@google.com
