From 9b9a8f39b60ba68aa21b518f012e6878c51a76af Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Mon, 19 Apr 2021 20:35:56 -0400 Subject: [PATCH] Remove WIP Signed-off-by: Adam Harvey --- plugins/catalog/README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/plugins/catalog/README.md b/plugins/catalog/README.md index e9405a41f5..2940fecaa1 100644 --- a/plugins/catalog/README.md +++ b/plugins/catalog/README.md @@ -1,12 +1,25 @@ -# Catalog Frontend - -WORK IN PROGRESS +# Backstage Catalog Frontend This is the frontend part of the default catalog plugin. It will implement the core API for handling your catalog of software, and supply the base views to show and manage them. +## Getting Started + +This frontend plugin can be started in a standalone mode from directly in this package +with `yarn start`. However, it will have limited functionality and that process is +most convenient when developing the catalog frontend plugin itself. + +To evaluate the catalog and have a greater amount of functionality available, from the main +Backstage root folder, instead do: + +```bash +yarn dev +``` + +This will launch both the front and backend in same window, populated some example entities. + ## Links - [Backend part of the plugin](https://github.com/backstage/backstage/tree/master/plugins/catalog-backend)