{"id":19251624,"url":"https://github.com/tonicpow/twetch-bot","last_synced_at":"2025-04-21T13:30:33.145Z","repository":{"id":37801373,"uuid":"287333959","full_name":"tonicpow/twetch-bot","owner":"tonicpow","description":"TonicPow's official bot for posting on Twetch","archived":false,"fork":false,"pushed_at":"2025-04-21T11:53:49.000Z","size":2719,"stargazers_count":4,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-21T12:42:56.727Z","etag":null,"topics":["bot","node","rss","tonicpow","twetch"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/tonicpow.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":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"tonicpow","custom":"https://tonicpow.com/?utm_source=github\u0026utm_medium=sponsor-link\u0026utm_campaign=twetch-bot\u0026utm_term=twetch-bot\u0026utm_content=twetch-bot"}},"created_at":"2020-08-13T16:53:24.000Z","updated_at":"2025-04-21T11:53:46.000Z","dependencies_parsed_at":"2023-10-11T12:14:38.784Z","dependency_job_id":"62ec66d1-0686-4c24-90d7-3644fb9dbd2a","html_url":"https://github.com/tonicpow/twetch-bot","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonicpow%2Ftwetch-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonicpow%2Ftwetch-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonicpow%2Ftwetch-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonicpow%2Ftwetch-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tonicpow","download_url":"https://codeload.github.com/tonicpow/twetch-bot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250064483,"owners_count":21368913,"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":["bot","node","rss","tonicpow","twetch"],"created_at":"2024-11-09T18:23:17.601Z","updated_at":"2025-04-21T13:30:32.802Z","avatar_url":"https://github.com/tonicpow.png","language":"TypeScript","funding_links":["https://github.com/sponsors/tonicpow","https://tonicpow.com/?utm_source=github\u0026utm_medium=sponsor-link\u0026utm_campaign=twetch-bot\u0026utm_term=twetch-bot\u0026utm_content=twetch-bot","https://github.com/sponsors/TonicPow"],"categories":[],"sub_categories":[],"readme":"# TonicPow: Twetch Bot\n\n\u003e The official TonicPow bot for posting on [Twetch](https://twetch.app)\n\n[![last commit](https://img.shields.io/github/last-commit/tonicpow/twetch-bot.svg?style=flat\u0026v=1)](https://github.com/tonicpow/twetch-bot/commits/master)\n[![version](https://img.shields.io/github/release-pre/tonicpow/twetch-bot.svg?style=flat\u0026v=1)](https://github.com/tonicpow/twetch-bot/releases)\n[![Build Status](https://img.shields.io/github/workflow/status/tonicpow/twetch-bot/CodeQL?logo=github\u0026v=5)](https://github.com/tonicpow/twetch-bot/actions)\n[![Mergify Status](https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/tonicpow/twetch-bot\u0026style=flat\u0026v=5)](https://mergify.io)\n\u003cbr\u003e\n[![Sponsor](https://img.shields.io/badge/sponsor-TonicPow-181717.svg?logo=github\u0026style=flat\u0026v=1)](https://github.com/sponsors/TonicPow)\n[![slack](https://img.shields.io/badge/slack-tonicpow-orange.svg?style=flat\u0026v=1)](https://atlantistic.slack.com/app_redirect?channel=tonicpow)\n\n\u003cbr/\u003e\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Documentation](#documentation)\n- [Examples \u0026 Tests](#examples--tests)\n- [Maintainers](#maintainers)\n- [Contributing](#contributing)\n- [License](#license)\n\n\u003cbr/\u003e\n\n## Pre-Requisites\n\nThese are required for building and running the Typescript project:\n\n```shell script\nyarn global add tsc\nyarn global add ts-node-dev\n```\n\n## Installation\n\n#### Yarn\n\nInstall:\n\n```shell script\nyarn\n```\n\nLocal development (watch):\n\n```shell script\nyarn dev\n```\n\nBuild \u0026 run with:\n\n```shell script\nyarn prod\n```\n\n#### PM2\n\n```shell script\npm2 start yarn --name api -- prod\n```\n\n#### Make\n\n**twetch-bot** requires a [supported release of Node](https://nodejs.org/en/download/).\n\n```shell script\nmake install\n```\n\nRun the bot with:\n\n```shell script\nmake start\n```\n\n\u003cbr/\u003e\n\n## Documentation\n\nThe bot will query `RSSURL` to check for new campaigns every X seconds as defined in the `refreshRate` parameter in the .env file.\n\nIf new campaigns are found, then the bot will automatically [twetch](https://twetch.app) those links with the `privateKey` configured in the .env file.\n\nOnce a `privateKey` is setup, upon starting the bot the signing address will be logged along with the message and signature necessary to configure in the [twetch account](https://twetch.app/developer).\n\nThe [client identifier](https://twetch.app/developer) should also be configured in the .env file to take advantage of 10% platform fee savings.\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e\u003ccode\u003eEnvironment Variables\u003c/code\u003e\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr/\u003e\n\nRequired environment variables:\n\n- `TWETCH_CLIENT_ID` (twetch client id)\n- `TWETCH_PK` (private key for twetch account)\n- `TWETCH_REFRESH_RATE` (rate to refresh/fetch new rss)\n\u003c/details\u003e\n\n### Features\n\n- Consume the TonicPow RSS feed\n- Auto post on new campaigns\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e\u003ccode\u003eRelease Deployment\u003c/code\u003e\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr/\u003e\n\n[goreleaser](https://github.com/goreleaser/goreleaser) for easy binary or library deployment to Github and can be installed via: `brew install goreleaser`.\n\nThe [.goreleaser.yml](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/goreleaser).\n\nUse `make release-snap` to create a snapshot version of the release, and finally `make release` to ship to production.\n\n\u003c/details\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\n```shell script\nmake help\n```\n\nList of all current commands:\n\n```text\naudit                          Checks for vulnerabilities in dependencies\nclean                          Remove previous builds and any test cache data\nhelp                           Show all commands available\ninstall                        Installs the dependencies for the package\nlint                           Runs the standard-js lint tool\noutdated                       Checks for outdated packages via npm\nrelease                        Full production release (creates release in Github)\nrelease-test                   Full production test release (everything except deploy)\nrelease-snap                   Test the full release (build binaries)\nstart                          Starts running the bot\ntag                            Generate a new tag and push (IE: tag version=0.0.0)\ntag-remove                     Remove a tag if found (IE: tag-remove version=0.0.0)\ntag-update                     Update an existing tag to current commit (IE: tag-update version=0.0.0)\nupdate-releaser                Update the goreleaser application\n```\n\n\u003c/details\u003e\n\n\u003cbr/\u003e\n\n## Examples \u0026 Tests\n\nTests \u0026 examples coming soon!\n\n\u003cbr/\u003e\n\n## Maintainers\n\n| [\u003cimg src=\"https://github.com/jdh7190.png\" height=\"50\" alt=\"Josh\" /\u003e](https://github.com/jdh7190) | [\u003cimg src=\"https://github.com/rohenaz.png\" height=\"50\" alt=\"Satchmo\" /\u003e](https://github.com/rohenaz) | [\u003cimg src=\"https://github.com/mrz1836.png\" height=\"50\" alt=\"MrZ\" /\u003e](https://github.com/mrz1836) |\n|:-------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------:|\n|                                [Josh](https://github.com/jdh7190)                                 |                                [Satchmo](https://github.com/rohenaz)                                 |                                [MrZ](https://github.com/mrz1836)                                 |\n\n\u003cbr/\u003e\n\n## Contributing\nView the [contributing guidelines](.github/CONTRIBUTING.md) and please follow the [code of conduct](.github/CODE_OF_CONDUCT.md).\n\n### How can I help?\nAll kinds of contributions are welcome :raised_hands:!\nThe most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:.\nYou can also support this project by [becoming a sponsor on GitHub](https://github.com/sponsors/tonicpow) :clap:\nor by making a [**bitcoin donation**](https://tonicpow.com/?utm_source=github\u0026utm_medium=sponsor-link\u0026utm_campaign=twetch-bot\u0026utm_term=twetch-bot\u0026utm_content=twetch-bot) to ensure this journey continues indefinitely! :rocket:\n\n\n[![Stars](https://img.shields.io/github/stars/tonicpow/twetch-bot?label=Please%20like%20us\u0026style=social)](https://github.com/tonicpow/twetch-bot/stargazers)\n\n\u003cbr/\u003e\n\n## License\n\n[![license](https://img.shields.io/badge/license-Open%20BSV-brightgreen.svg?style=flat)](/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftonicpow%2Ftwetch-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftonicpow%2Ftwetch-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftonicpow%2Ftwetch-bot/lists"}