aboutsummaryrefslogtreecommitdiff
path: root/packages/demobank-ui/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/demobank-ui/README.md')
-rw-r--r--packages/demobank-ui/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/packages/demobank-ui/README.md b/packages/demobank-ui/README.md
new file mode 100644
index 000000000..c014929ce
--- /dev/null
+++ b/packages/demobank-ui/README.md
@@ -0,0 +1,19 @@
+# bank web
+
+## CLI Commands
+
+- `npm install`: Installs dependencies
+
+- `npm run dev`: Run a development, HMR server
+
+- `npm run serve`: Run a production-like server
+
+- `npm run build`: Production-ready build
+
+- `npm run lint`: Pass TypeScript files using ESLint
+
+- `npm run test`: Run Jest and Enzyme with
+ [`enzyme-adapter-preact-pure`](https://github.com/preactjs/enzyme-adapter-preact-pure) for
+ your tests
+
+For detailed explanation on how things work, checkout the [CLI Readme](https://github.com/developit/preact-cli/blob/master/README.md).