From 9ef080ed8f82ae7416cdb482d2d16dd6a079b2c9 Mon Sep 17 00:00:00 2001 From: Ben Gazzard Date: Mon, 23 Oct 2023 18:05:34 +0100 Subject: [PATCH] Readme update --- enclave-manager/web/README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/enclave-manager/web/README.md b/enclave-manager/web/README.md index 341e7fa9bb..29d5eee80d 100644 --- a/enclave-manager/web/README.md +++ b/enclave-manager/web/README.md @@ -1,16 +1,22 @@ # Enclave Manager UI (EMUI) This codebase produces the enclave manager UI (ie `kurtosis web`). The `src` directory contains: -* `components` - components that can be shared between the EMUI and Kurtosis Cloud. This includes theme definitions and application context definitions +* `components` - components used in the application. This includes theme definitions and application context definitions * `client` - libraries for interacting with the local `kurtosis` backend - used to instantiate a `KurtosisAppContext` and interacted with using `useKurtosis` -* `emui` - the composition of the above to produce the Enclave Manager UI - -At a later date we will explore splitting these directories to individual packages so that they can be shared to Kurtosis Cloud. +* `emui` - the composition of the above to produce the Enclave Manager UI using react router ## Available Scripts In the project directory, you can run: +### `yarn cleanInstall` + +Removes `node_modules` and runs `yarn install`. + +### `yarn clean` + +Removes the build output if present. + ### `yarn start` Runs the app in the development mode.\