# edgex-ui-go

**Repository Path**: EdgexFoundry/edgex-ui-go

## Basic Information

- **Project Name**: edgex-ui-go
- **Description**: The EdgeX UI is for demonstration and developer use to manage and monitor a single instance of EdgeX Foundry
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 3
- **Created**: 2020-09-28
- **Last Updated**: 2025-08-27

## Categories & Tags

**Categories**: iot

**Tags**: None

## README

# edgex-ui-go
[![Build Status](https://jenkins.edgexfoundry.org/view/EdgeX%20Foundry%20Project/job/edgexfoundry/job/edgex-ui-go/job/main/badge/icon)](https://jenkins.edgexfoundry.org/view/EdgeX%20Foundry%20Project/job/edgexfoundry/job/edgex-ui-go/job/main/) [![Code Coverage](https://codecov.io/gh/edgexfoundry/edgex-ui-go/branch/main/graph/badge.svg?token=d1UQog1ja0)](https://codecov.io/gh/edgexfoundry/edgex-ui-go) [![Go Report Card](https://goreportcard.com/badge/github.com/edgexfoundry/edgex-ui-go)](https://goreportcard.com/report/github.com/edgexfoundry/edgex-ui-go) [![GitHub Latest Dev Tag)](https://img.shields.io/github/v/tag/edgexfoundry/edgex-ui-go?include_prereleases&sort=semver&label=latest-dev)](https://github.com/edgexfoundry/edgex-ui-go/tags) ![GitHub Latest Stable Tag)](https://img.shields.io/github/v/tag/edgexfoundry/edgex-ui-go?sort=semver&label=latest-stable) [![GitHub License](https://img.shields.io/github/license/edgexfoundry/edgex-ui-go)](https://choosealicense.com/licenses/apache-2.0/) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/edgexfoundry/edgex-ui-go) [![GitHub Pull Requests](https://img.shields.io/github/issues-pr-raw/edgexfoundry/edgex-ui-go)](https://github.com/edgexfoundry/edgex-ui-go/pulls) [![GitHub Contributors](https://img.shields.io/github/contributors/edgexfoundry/edgex-ui-go)](https://github.com/edgexfoundry/edgex-ui-go/contributors) [![GitHub Committers](https://img.shields.io/badge/team-committers-green)](https://github.com/orgs/edgexfoundry/teams/edgex-ui-go-committers/members) [![GitHub Commit Activity](https://img.shields.io/github/commit-activity/m/edgexfoundry/edgex-ui-go)](https://github.com/edgexfoundry/edgex-ui-go/commits)


## Use and Purpose
The EdgeX UI is for **demonstration and developer use** to manage and monitor a single instance of EdgeX Foundry (insecure or secure).  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.


<p align="center">
  <img src ="assets/images/metadata.png" />
</p>

## Install and Deploy

* Make sure you're using at least Go 1.12 (UI backend server currently uses Go 1.18.x)
* If your code is in your GOPATH then make sure ```GO111MODULE=on``` is set

```
git clone http://github.com/edgexfoundry/edgex-ui-go.git
cd edgex-ui-go
make build
```

To start the application and the web-based UI:

```
export EDGEX_SECURITY_SECRET_STORE=false
make run
```

To rebuild after making changes to source:

```
make clean
make build
```

To test the web-based UI:

```
make test
```

## Using the edgex-ui

With a modern browser, navigate to http://yourdomain:4000 (change *yourdomain* to your server's hostname or ip). 
> NOTE: the GUI is running in non-secure mode when the environment variable EDGEX_SECURITY_SECRET_STORE=false, if EDGEX_SECURITY_SECRET_STORE=true, the accesss token for edgex is required, see the edgex document how to get the token.

> NOTE: make sure that EdgeXFoundry is already running, Please refer to [Edgex Services Get Started](https://docs.edgexfoundry.org/latest/getting-started/). 

## [User guide](https://docs.edgexfoundry.org/latest/getting-started/tools/Ch-GUI/)


## Other installation and deployment options

### Build your own Docker Containers

```
make docker
```

## Community
- [EdgeXFoundry Chinese Website](https://cn.edgexfoundry.org/)
- [Discussion](https://github.com/orgs/edgexfoundry/discussions)
- [Mailing lists](https://lists.edgexfoundry.org/g/main)

## License
[Apache-2.0](LICENSE)

## Feedback

- If you want to learn how to use the UI, you can refer to the user guide [user guide](https://docs.edgexfoundry.org/2.1/getting-started/tools/Ch-GUI/).

- If you find a bug or want to request a new feature, please open a [GitHub Issue](https://github.com/edgexfoundry/edgex-ui-go/issues).