{"id":18254695,"url":"https://github.com/bitcoin-sv/alert-system","last_synced_at":"2026-03-02T11:33:40.091Z","repository":{"id":222690725,"uuid":"710825996","full_name":"bitcoin-sv/alert-system","owner":"bitcoin-sv","description":"Alert System Microservice","archived":false,"fork":false,"pushed_at":"2024-10-21T14:22:30.000Z","size":903,"stargazers_count":3,"open_issues_count":10,"forks_count":2,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-21T20:48:56.316Z","etag":null,"topics":["alert-system","bitcoin","bsv","golang","microservice"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bitcoin-sv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":".github/SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"bitcoin-sv"}},"created_at":"2023-10-27T14:13:14.000Z","updated_at":"2024-10-21T13:10:50.000Z","dependencies_parsed_at":"2024-04-03T20:23:58.767Z","dependency_job_id":"d2152e73-dbdf-4397-add4-1fdde07d5058","html_url":"https://github.com/bitcoin-sv/alert-system","commit_stats":null,"previous_names":["bitcoin-sv/alert-system"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitcoin-sv%2Falert-system","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitcoin-sv%2Falert-system/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitcoin-sv%2Falert-system/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitcoin-sv%2Falert-system/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitcoin-sv","download_url":"https://codeload.github.com/bitcoin-sv/alert-system/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223150706,"owners_count":17095959,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alert-system","bitcoin","bsv","golang","microservice"],"created_at":"2024-11-05T10:13:17.324Z","updated_at":"2026-03-02T11:33:40.027Z","avatar_url":"https://github.com/bitcoin-sv.png","language":"Go","funding_links":["https://github.com/sponsors/bitcoin-sv"],"categories":[],"sub_categories":[],"readme":"# alert-system\n\u003e A go microservice for managing alerts and runs alongside Bitcoin SV nodes utilizing RPC\n\n[![Release](https://img.shields.io/github/release-pre/bitcoin-sv/alert-system.svg?logo=github\u0026style=flat\u0026v=3)](https://github.com/bitcoin-sv/alert-system/releases)\n[![Build](https://github.com/bitcoin-sv/alert-system/actions/workflows/run-tests.yml/badge.svg?branch=master\u0026v=3)](https://github.com/bitcoin-sv/alert-system/actions)\n[![Report](https://goreportcard.com/badge/github.com/bitcoin-sv/alert-system?style=flat\u0026v=3)](https://goreportcard.com/report/github.com/bitcoin-sv/alert-system)\n[![Go](https://img.shields.io/github/go-mod/go-version/bitcoin-sv/alert-system?v=3)](https://golang.org/)\n[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat\u0026v=3)](https://github.com/RichardLitt/standard-readme)\n[![Makefile Included](https://img.shields.io/badge/Makefile-Supported%20-brightgreen?=flat\u0026logo=probot\u0026v=3)](Makefile)\n\n\u003cbr/\u003e\n\n## Table of Contents\n- [Installation](#run-from-source)\n- [Documentation](#documentation)\n- [Examples \u0026 Tests](#examples--tests)\n- [Benchmarks](#benchmarks)\n- [Code Standards](#code-standards)\n- [Contributing](#contributing)\n- [License](#license)\n\n\u003cbr/\u003e\n\n## Run from source\n\n**alert-system** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).\n\nTo run the application, clone this repository locally and run:\n```shell script\nexport ALERT_SYSTEM_ENVIRONMENT=testnet \u0026\u0026 go run cmd/main.go\n```\n\nTo run this application with a custom configuration file, run:\n```shell script\nexport ALERT_SYSTEM_CONFIG_FILEPATH=path/to/file/config.json \u0026\u0026 go run cmd/main.go\n```\n\nConfiguration files can be found in the [config](app/config/envs) directory.\n\n\u003cbr/\u003e\n\n## Container Environment\n**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.\n### podman\n```\n$ podman run -u root -e ALERT_SYSTEM_ENVIRONMENT=testnet  --expose 9906 docker.io/bsvb/alert-key:latest\n```\n\n## Documentation\nView the [official documentation](https://node.bitcoinsv.io/sv-node/alert-system)\n\n\u003cbr/\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e\u003ccode\u003eMakefile Commands\u003c/code\u003e\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr/\u003e\n\nView all `makefile` commands\n```shell script\nmake help\n```\n\nList of all current commands:\n```text\nall                   Runs multiple commands\nclean                 Remove previous builds and any cached data\nclean-mods            Remove all the Go mod cache\ncoverage              Shows the test coverage\ndiff                  Show the git diff\ngenerate              Runs the go generate command in the base of the repo\ngodocs                Sync the latest tag with GoDocs\nhelp                  Show this help message\ninstall               Install the application\ninstall-go            Install the application (Using Native Go)\ninstall-releaser      Install the GoReleaser application\nlint                  Run the golangci-lint application (install if not found)\nrelease               Full production release (creates release in GitHub)\nrelease               Runs common.release then runs godocs\nrelease-snap          Test the full release (build binaries)\nrelease-test          Full production test release (everything except deploy)\nreplace-version       Replaces the version in HTML/JS (pre-deploy)\ntag                   Generate a new tag and push (tag version=0.0.0)\ntag-remove            Remove a tag if found (tag-remove version=0.0.0)\ntag-update            Update an existing tag to current commit (tag-update version=0.0.0)\ntest                  Runs lint and ALL tests\ntest-ci               Runs all tests via CI (exports coverage)\ntest-ci-no-race       Runs all tests via CI (no race) (exports coverage)\ntest-ci-short         Runs unit tests via CI (exports coverage)\ntest-no-lint          Runs just tests\ntest-short            Runs vet, lint and tests (excludes integration tests)\ntest-unit             Runs tests and outputs coverage\nuninstall             Uninstall the application (and remove files)\nupdate-linter         Update the golangci-lint package (macOS only)\nvet                   Run the Go vet application\n```\n\u003c/details\u003e\n\n\u003cbr/\u003e\n\n## Examples \u0026 Tests\nAll unit tests and examples run via [GitHub Actions](https://github.com/bitcoin-sv/alert-system/actions) and\nuses [Go version 1.21.x](https://golang.org/doc/go1.21). View the [configuration file](.github/workflows/run-tests.yml).\n\n\u003cbr/\u003e\n\nRun all tests (including integration tests)\n```shell script\nmake test\n```\n\n\u003cbr/\u003e\n\nRun tests (excluding integration tests)\n```shell script\nmake test-short\n```\n\n\u003cbr/\u003e\n\n## Benchmarks\nRun the Go benchmarks:\n```shell script\nmake bench\n```\n\n\u003cbr/\u003e\n\n## Code Standards\nRead more about this Go project's [code standards](.github/CODE_STANDARDS.md).\n\n\u003cbr/\u003e\n\n## Contributing\nView the [contributing guidelines](.github/CONTRIBUTING.md) and follow the [code of conduct](.github/CODE_OF_CONDUCT.md).\n\n\u003cbr/\u003e\n\n## License\n\n[![License](https://img.shields.io/badge/license-OpenBSV-green.svg?style=flat\u0026v=2)](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitcoin-sv%2Falert-system","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitcoin-sv%2Falert-system","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitcoin-sv%2Falert-system/lists"}