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.
To install the Flux Web UI:
- Download the latest release from the releases page
- Extract the binary from the downloaded archive
- Run the server in your terminal:
./flux_webui
- You will see a log message letting you know startup was successful:
2021-06-03T13:26:37.552-0700 INFO Serving on port 9000
- Navigate to http://localhost:9000
To set up a development environment
- Install
go
v1.16 - Install Node.js version 14.15.1
- Install
reflex
for automated server builds:go get github.com/cespare/reflex
- Install
kubebuilder
npm install
to install UI dependenciesmake dev
to compile and run the appnpm start
to start the frontend dev server (with hot-reloading)- Navigate to http://localhost:1234 to view the frontend dev UI (with hot-reloading)
- 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