Skip to content

Commit ed12490

Browse files
authored
Update README.md
Add bundle watch info
1 parent c4c8169 commit ed12490

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

packages/web-console/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,19 @@ yarn workspace @questdb/web-console run build
6666

6767
3. Build process emits static HTML, CSS and JS files in `packages/web-console/dist`
6868

69+
## Bundle size watcher
70+
Web Console uses [BundleWatcher](https://github.com/bundlewatch/bundlewatch) to make sure there is no unintentional blowup of assets size. The current limits, defined in the `package.json`, are as following:
71+
72+
73+
| File | Max allowed size |
74+
|--------|--------|
75+
| dist/vendor.*.js | 3MB |
76+
| dist/qdb.*.js | 500KB |
77+
| dist/qdb.*.css | 100KB |
78+
| dist/vendor.*.css | 100KB |
79+
80+
If you need to introduce a heavy library or anything that by design is expected to go over the defined limits, make sure to change the watcher configuration.
81+
6982
## Run tests
7083

7184
### Unit tests

0 commit comments

Comments
 (0)