Skip to content

Commit

Permalink
closes #2 added heroku btn
Browse files Browse the repository at this point in the history
  • Loading branch information
H1D committed Jul 9, 2024
1 parent 804b1df commit 0af8086
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,15 @@ Keep in mind – one bot instance – one repo. So if you want to create issues
GH_REPO=user/repo
```

4. **Run the bot**. Here is an example:
4. **Run the bot**. Deploy ready docker image somewhere. For example use Heroku template – [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/yourusername/telegram-to-github-bot). Local run example:
```sh
docker run --env-file .env ghcr.io/h1d/telegram-to-github-bot:main
```
5. **Add the bot to your group(s)**
6. **Start creating issues!**

## Deploy to Heroku

You can easily deploy this bot to Heroku by clicking the button below:

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/yourusername/telegram-to-github-bot)
25 changes: 25 additions & 0 deletions app.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"name": "Telegram to GitHub Bot",
"description": "A Telegram bot to create GitHub issues simply by @mentioning.",
"repository": "https://github.com/H1D/telegram-to-github-bot",
"logo": "https://github.com/H1D/telegram-to-github-bot/assets/697625/2ae5fc94-f261-42dd-b6c9-37b3c35b876b",
"keywords": ["telegram", "bot", "github", "issues"],
"env": {
"TELEGRAM_BOT_TOKEN": {
"description": "Your Telegram bot token",
"required": true
},
"GITHUB_TOKEN": {
"description": "Your GitHub personal access token",
"required": true
},
"GH_REPO": {
"description": "The repository where issues will be created",
"required": true
},
"ISSUE_TAGS": {
"description": "Comma-separated list of tags to be added to the issue",
"required": false
}
}
}

0 comments on commit 0af8086

Please sign in to comment.