README
¶
edugroup-ui-go
Use and Purpose
The EdgeX UI is for demonstration and developer use to manage and monitor a single instance of EdgeX Foundry (unsecured). Specifically, it can:
- Manage (add, remove, update) the EdgeX objects (device, device services, profiles, rules, app services, etc.)
- Monitor the EdgeX data flow (events and readings) and services
- Monitor and manage from on-box with EdgeX (on the same host)
As is, the EdgeX UI is not meant for production use! Developers can use the UI as a base from which to create additional user interfaces. The EdgeX community is also exploring production level use cases and extending/expanding the UI for future releases that would include more production level needs such as the ability to use the UI from on or off box.
Go implementation of EdgeX Web UI.
User guide and operation video
-
If you want to learn how to use the UI, you can refer to the user guide user guide.
Install and Deploy
To fetch the code and compile the web-based UI:
Using go get:
go get github.com/phanvanhai/edugroup-ui-go
cd $GOPATH/src/github.com/phanvanhai/edugroup-ui-go
make build
Using Git:
cd $GOPATH/src
git clone http://github.com/phanvanhai/edugroup-ui-go.git github.com/phanvanhai/edugroup-ui-go
cd $GOPATH/src/github.com/phanvanhai/edugroup-ui-go
make build
To start the application and the web-based UI:
make run
To rebuild after making changes to source:
make clean
make build
To test the web-based UI:
make test
To start all the EdgeX Go microservices in Docker, run the following command in the root of the EdgeX Go directory:
make run_docker
With a modern browser, navigate to http://yourdomain:4000 (change yourdomain to your server's hostname or ip).
NOTE: make sure that EdgeXFoundry is already running, Please refer to Edgex Services Get Started.
NOTE: if you want remote access the UI, you shuold remove the UI network in docker-compose.yml, this way you can allow the UI to live someplace else and have access to EdgeX through Kong.
Community
- EdgeXFoundry Chinese Club: https://www.edgexfoundry.club
- Chat: https://chat.edgexfoundry.org/home
- Mainling lists: https://lists.edgexfoundry.org/mailman/listinfo
License
Feedback
-
If you want to learn how to use the UI, you can refer to the user guide user guide.
-
If you find a bug or want to request a new feature, please open a GitHub Issue.
-
Have a online chat at the appointed time on the zoom.
Note Please contact to us before you want to have a online chat.
Documentation
Source Files
Directories