diff --git a/frontend/README.md b/frontend/README.md new file mode 100644 index 0000000000..5c288e4d59 --- /dev/null +++ b/frontend/README.md @@ -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