Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
Dartoxian committed Oct 23, 2023
1 parent 88fb7e8 commit 9ef080e
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions enclave-manager/web/README.md
Original file line number Diff line number Diff line change
@@ -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.\
Expand Down

0 comments on commit 9ef080e

Please sign in to comment.