isabella232 / webui

Experimental UI for Flux version 2

Flux Web UI

Project Status

⚠️ This project is currently on hold, because the maintainers do not have capacity to develop it further at present. We (the Flux project) will try to keep it up to date with the Flux APIs so it will still run, but it will remain experimental and may not always work (please file an issue if you find it does not work!).

Please get in touch in #flux-contributors if you are interested in helping to get this project moving again.

See the monitoring section of the Flux documentation for how to install Flux's Grafana dashboards.

Installation

To install the Flux Web UI:

1. Download the latest release from the releases page
2. Extract the binary from the downloaded archive
3. Run the server in your terminal: ./flux-webui
4. You will see a log message letting you know startup was successful: 2021-06-03T13:26:37.552-0700 INFO Serving on port 9000
5. Navigate to http://localhost:9000

Development

To set up a development environment

1. Install go v1.16
2. Install Node.js v16.x.x
3. Install reflex for automated server builds: go get github.com/cespare/reflex
4. Install kubebuilder
5. npm install to install UI dependencies
6. make dev to compile and run the app
7. npm start to start the frontend dev server (with hot-reloading)
8. Navigate to http://localhost:1234 to view the frontend dev UI (with hot-reloading)
9. Navigate to http://localhost:9000 to see the UI served from the go program

To generate protobuf files natively on your OS, install protoc, then install these packages:

go get -u github.com/golang/protobuf/protoc-gen-go
go get -u github.com/twitchtv/twirp/protoc-gen-twirp
go get -u go.larrymyers.com/protoc-gen-twirp_typescript

Then run:

make proto

To run tests:

make test