Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bitcoin-sv/alert-system
Alert System Microservice
https://github.com/bitcoin-sv/alert-system
alert-system bitcoin bsv golang microservice
Last synced: 13 days ago
JSON representation
Alert System Microservice
- Host: GitHub
- URL: https://github.com/bitcoin-sv/alert-system
- Owner: bitcoin-sv
- License: other
- Created: 2023-10-27T14:13:14.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-21T14:22:30.000Z (28 days ago)
- Last Synced: 2024-10-21T20:48:56.316Z (27 days ago)
- Topics: alert-system, bitcoin, bsv, golang, microservice
- Language: Go
- Homepage:
- Size: 882 KB
- Stars: 3
- Watchers: 6
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
# alert-system
> A go microservice for managing alerts and runs alongside Bitcoin SV nodes utilizing RPC
[](https://github.com/bitcoin-sv/alert-system/releases)
[](https://github.com/bitcoin-sv/alert-system/actions)
[](https://goreportcard.com/report/github.com/bitcoin-sv/alert-system)
[](https://golang.org/)
[](https://github.com/RichardLitt/standard-readme)
[](Makefile)
## Table of Contents
- [Installation](#run-from-source)
- [Documentation](#documentation)
- [Examples & Tests](#examples--tests)
- [Benchmarks](#benchmarks)
- [Code Standards](#code-standards)
- [Contributing](#contributing)
- [License](#license)
## Run from source
**alert-system** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).
To run the application, clone this repository locally and run:
```shell script
export ALERT_SYSTEM_ENVIRONMENT=testnet && go run cmd/main.go
```
To run this application with a custom configuration file, run:
```shell script
export ALERT_SYSTEM_CONFIG_FILEPATH=path/to/file/config.json && go run cmd/main.go
```
Configuration files can be found in the [config](app/config/envs) directory.
## Container Environment
**Note:** to use a custom settings file, it needs to be mounted and the appropriate environment variables set. Running it as below will run an ephemeral database but the container should sync up from the peers on the network on startup.
### podman
```
$ podman run -u root -e ALERT_SYSTEM_ENVIRONMENT=testnet --expose 9906 docker.io/bsvb/alert-key:latest
```
## Documentation
View the [official documentation](https://node.bitcoinsv.io/sv-node/alert-system)
Makefile Commands
View all `makefile` commands
```shell script
make help
```
List of all current commands:
```text
all Runs multiple commands
clean Remove previous builds and any cached data
clean-mods Remove all the Go mod cache
coverage Shows the test coverage
diff Show the git diff
generate Runs the go generate command in the base of the repo
godocs Sync the latest tag with GoDocs
help Show this help message
install Install the application
install-go Install the application (Using Native Go)
install-releaser Install the GoReleaser application
lint Run the golangci-lint application (install if not found)
release Full production release (creates release in GitHub)
release Runs common.release then runs godocs
release-snap Test the full release (build binaries)
release-test Full production test release (everything except deploy)
replace-version Replaces the version in HTML/JS (pre-deploy)
tag Generate a new tag and push (tag version=0.0.0)
tag-remove Remove a tag if found (tag-remove version=0.0.0)
tag-update Update an existing tag to current commit (tag-update version=0.0.0)
test Runs lint and ALL tests
test-ci Runs all tests via CI (exports coverage)
test-ci-no-race Runs all tests via CI (no race) (exports coverage)
test-ci-short Runs unit tests via CI (exports coverage)
test-no-lint Runs just tests
test-short Runs vet, lint and tests (excludes integration tests)
test-unit Runs tests and outputs coverage
uninstall Uninstall the application (and remove files)
update-linter Update the golangci-lint package (macOS only)
vet Run the Go vet application
```
## Examples & Tests
All unit tests and examples run via [GitHub Actions](https://github.com/bitcoin-sv/alert-system/actions) and
uses [Go version 1.21.x](https://golang.org/doc/go1.21). View the [configuration file](.github/workflows/run-tests.yml).
Run all tests (including integration tests)
```shell script
make test
```
Run tests (excluding integration tests)
```shell script
make test-short
```
## Benchmarks
Run the Go benchmarks:
```shell script
make bench
```
## Code Standards
Read more about this Go project's [code standards](.github/CODE_STANDARDS.md).
## Contributing
View the [contributing guidelines](.github/CONTRIBUTING.md) and follow the [code of conduct](.github/CODE_OF_CONDUCT.md).
## License
[](LICENSE)