mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-13 23:16:45 +00:00
ba92ba3254
* docs: Create new CODING_GUIDELINES doc Rids excess contribution instructions from other packages Adds AGENTS.md file for the AI overlords Rids unused templates Updates ADD_NEW_EXCHANGE.md with minor fixes * docs: Fix linter issues and minor adjustments based on Copilot feedback * docs: Update coding guidelines for API parameters and testing practices * docs: Remove redundant GoDoc references Adds copilot-instructions.md * docs: Update CODING_GUIDELINES with export recommendations and test commentary * docs: Fix formatting inconsistencies in ADD_NEW_EXCHANGE.md links * docs: Update struct naming conventions for request and response types * docs: Improve clarity and consistency in ADD_NEW_EXCHANGE.md and CODING_GUIDELINES.md * refactor: Simplify error handling in QueryOrder method
76 lines
4.1 KiB
Markdown
76 lines
4.1 KiB
Markdown
# GoCryptoTrader package Communication Manager
|
|
|
|
<img src="/common/gctlogo.png?raw=true" width="350px" height="350px" hspace="70">
|
|
|
|
|
|
[](https://github.com/thrasher-corp/gocryptotrader/actions/workflows/tests.yml)
|
|
[](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE)
|
|
[](https://godoc.org/github.com/thrasher-corp/gocryptotrader/engine/communication_manager)
|
|
[](https://codecov.io/gh/thrasher-corp/gocryptotrader)
|
|
[](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader)
|
|
|
|
|
|
This communication_manager package is part of the GoCryptoTrader codebase.
|
|
|
|
## This is still in active development
|
|
|
|
You can track ideas, planned features and what's in progress on our [GoCryptoTrader Kanban board](https://github.com/orgs/thrasher-corp/projects/3).
|
|
|
|
Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://join.slack.com/t/gocryptotrader/shared_invite/zt-38z8abs3l-gH8AAOk8XND6DP5NfCiG_g)
|
|
|
|
## Current Features for Communication Manager
|
|
+ The communication manager subsystem is used to push events raised in GoCryptoTrader to any enabled communication system such as a Slack server
|
|
+ In order to modify the behaviour of the communication manager subsystem, you can edit the following inside your config file under `communications`:
|
|
|
|
### slack
|
|
|
|
| Config | Description | Example |
|
|
| ------ | ----------- | ------- |
|
|
| enabled | Determines whether the push communications to a Slack server | `true` |
|
|
| verbose | If enabled will log more details to your logger output | `false` |
|
|
| targetChannel | The channel to send communications to | `announcements` |
|
|
| verificationToken | The token generated by Slack to allow interactions with the server and channel | `iamafaketoken` |
|
|
|
|
### smsGlobal
|
|
|
|
| Config | Description | Example |
|
|
| ------ | ----------- | ------- |
|
|
| name | The name of the SMS sender | `SMSGlobal` |
|
|
| from | Who the text name is from | `Skynet` |
|
|
| enabled | Determines whether the push communications to the SMS service | `true` |
|
|
| verbose | If enabled will log more details to your logger output | `false` |
|
|
| username | The username to use with the SMS provider | `username` |
|
|
| password | The username to use with the SMS provider | `password` |
|
|
| contacts | The `name` `number` of the user people you wish to send SMS to and whether it is `enabled` | `"name": "StyleGherkin", "number": "1231424", "enabled": true` |
|
|
|
|
### smtp
|
|
|
|
| Config | Description | Example |
|
|
| ------ | ----------- | ------- |
|
|
| name | The name of the service | `SMTP` |
|
|
| enabled | Determines whether the push communications to a email server | `true` |
|
|
| verbose | If enabled will log more details to your logger output | `false` |
|
|
| host | The SMTP host | `smtp.google.com` |
|
|
| port | The port to use | `537` |
|
|
| accountName | Your username | `username` |
|
|
| accountPassword | Your password | `password` |
|
|
| from | The display name of the sender | `Jeff Bezos` |
|
|
| recipientList | A comma delimited list of addresses to send alerts to | `bill@gates.com` |
|
|
|
|
### telegram
|
|
|
|
| Config | Description | Example |
|
|
| ------ | ----------- | ------- |
|
|
| name | The name to be displayed | `Telegram` |
|
|
| enabled | Determines whether the push communications to a Telegram server | `true` |
|
|
| verbose | If enabled will log more details to your logger output | `false` |
|
|
| verificationToken | The token generated by Telegram to allow you to send messages | `iamafaketoken` |
|
|
|
|
## Donations
|
|
|
|
<img src="https://github.com/thrasher-corp/gocryptotrader/blob/master/web/src/assets/donate.png?raw=true" hspace="70">
|
|
|
|
If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:
|
|
|
|
***bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc***
|