frontend: added basic readme

2020-02-03 00:07:35 +01:00
parent 49c7e5a605
commit 94f70bde1e
1 changed files with 49 additions and 0 deletions
@@ -0,0 +1,49 @@
+# Backstage Frontend
+
+## Usage
+
+Serve app:
+
+```bash
+yarn serve
+```
+
+Build app:
+
+```bash
+yarn build
+```
+
+Run all tests:
+
+```bash
+yarn test
+```
+
+Lint project:
+
+```bash
+yarn lint
+```
+
+Test a single package:
+
+```bash
+cd packages/plugins/hello-world
+
+yarn test
+```
+
+## Structure
+
+### `packages/app`
+
+Example application with a standard plugin wiring.
+
+### `packages/core`
+
+Core API package.
+
+### `packages/plugins/*`
+
+Plugins go here