Skip to content

Latest commit

 

History

History
78 lines (48 loc) · 2.98 KB

README.md

File metadata and controls

78 lines (48 loc) · 2.98 KB
Raw

Labs Workbench WebUI 2.x

Running instances of mongodb + apiserver are required.

Kubernetes

Prerequisites:

  • Kubernetes Cluster
  • Helm v3.7.0+

Install via Helm Chart

To install the full application and all dependencies via the Helm chart:

$ git clone https://github.com/nds-org/workbench-helm-chart && cd workbench-helm-chart
$ helm upgrade --install workbench -n workbench .

To customize the installation, see the Configuration section of the Helm chart.

Live editing TypeScript via Helm chart

To mount the webui compiled source into a webui dev container:

$ make dev

You can then re-compile the source using yarn build.

Once compilation has finished, your browser window should automatically refresh.

NOTE: Unfortunately, CRA doesn't provide a /build output folder while also watching for changes (a la ng build --watch), so true live-reload is not yet feasible. This would require an eject and for us to build up more tooling here for the build.

Local Development

Prerequisites:

  • node + npm [+ npx]
  • yarn

Run yarn install to fetch project dependencies. This is required for building the source.

In the project directory, you can run:

yarn swagger

Regenerate the swagger REST API client from the spec(s) in public/swagger*.yml.

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.