https://github.com/nymtech/node-status-api
An API to track uptime for Nym nodes
https://github.com/nymtech/node-status-api
Last synced: about 1 year ago
JSON representation
An API to track uptime for Nym nodes
- Host: GitHub
- URL: https://github.com/nymtech/node-status-api
- Owner: nymtech
- License: apache-2.0
- Created: 2021-03-29T13:30:29.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-03T12:28:45.000Z (about 5 years ago)
- Last Synced: 2024-06-19T20:51:24.566Z (about 2 years ago)
- Language: Go
- Size: 159 KB
- Stars: 13
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Node Status API
A monitoring API which stores node statuses for payment purposes.
Reports are stored in a SQLite database at `~/.nym/mixmining.db`
## Dependencies
* Go 1.15 or later
## Building and running
`go build` will build the binary.
## Usage
The server exposes an HTTP interface which can be queried. To see documentation
of the server's capabilities, go to http://:8081/swagger/index.html in
your browser once you've run the server. You'll be presented with an overview
of functionality. All methods are runnable through the Swagger docs interface,
so you can poke at the server to see what it does.
## Developing
`go test ./...` will run the test suite.
From the top-level `node-status-api` directory, `swag init -g main.go --output docs/` rebuilds the Swagger docs.