https://github.com/bwsix/annoyncement-line-bot

A Line bot on AWS, fully managed by terraform. What it does doesn't really matter.
https://github.com/bwsix/annoyncement-line-bot

Last synced: over 1 year ago
JSON representation

A Line bot on AWS, fully managed by terraform. What it does doesn't really matter.

• Host: GitHub
• URL: https://github.com/bwsix/annoyncement-line-bot
• Owner: BWsix
• License: gpl-3.0
• Created: 2024-01-05T07:44:39.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-01-08T17:53:19.000Z (over 2 years ago)
• Last Synced: 2024-04-24T03:22:50.692Z (about 2 years ago)
• Language: Python
• Homepage:
• Size: 6.22 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Annoyncement Line Bot

A Line bot for making announcements from one Line group to multiple Line groups.

###

| Make annoyncement                               | Activate bot with invite code          |

| :---------------------------------------------- | :------------------------------------- |

| ![annoyncement](./assets/make_annoyncement.gif) | ![invite bot](./assets/invite_bot.gif) |

### How to run the bot

#### Requirements

- python >= 3.8

- terraform >= 5

- aws account (each service used in this project is eligible for the AWS Free Tier)

#### Installation

1. Star this repo (thanks 😉)

2. **Fork** and clone **your repo** (could be a private one)

3. cd into `annoyncement-line-bot/terraform`

4. Copy `example.tfvars` to `prod.tfvars`

5. Configure `prod.tfvars`

   1. In `prod.tfvars`, change `repository` to your fork

   2. Generate a `Github personal access token (classic)`

      1. Go to 

      2. Select `repo` and `admin:repo_hook`

      3. In `prod.tfvars`, change `github_access_token` to your token

   3. Create a line bot

      1. Go to 

      2. Create a provider if you don't have one

      3. Create a new channel and select `Messaging API`

      4. In `Basic settings`, scroll to bottom and copy `Channel secret`

         1. In `prod.tfvars`, replace `linebot_secret` with your secret

      5. In `Messaging API`>`Webhook settings`, type `https://example.com` into `Webhook URL` and toggle `Use webhook`.

      6. In `Messaging API`, scroll to bottom and issue a `Channel access token (long-lived)`

         1. In `prod.tfvars`, replace `linebot_token` with your token

      7. In `Messaging API`, scan the QRcode to add the bot as a friend

   4. Configure the line bot

      1. Go to  and go the settings page by click on your bot

      2. Click `設定` on the top right corner of the page

      3. In `設定`>`帳號設定`>`功能切換`>`加入群組或多人聊天室`, choose `接受邀請加入群組或多人聊天室`

      4. In `設定`>`回應設定`>`回應設定`, enable `Webhook` and disable both `加入好友的歡迎訊息` and `自動回應訊息`

6. Apply the infrastructure

   1. Run `terraform init`

   2. Run `terraform apply -var-file prod.tfvars`

   3. Wait until `Apply complete!` shows up

7. Profit

   1. Invite the bot to the announcing group.\

      You will be prompted to set an `invite code`.

   2. Invite the bot to receiving groups.\

      The bot will send a link in the group, enter the invite code to activate the bot

   3. Make annoyncements

      1. In announcing group, type `annoy` or `Annoy`.

      2. Wait until the bot replies.

      3. Enter a text message or image message as your announcement

      4. It will show up on the receiving groups shortly

8. Clean up

   - Delete AWS resouces

     1. In `terraform` run `terraform destroy -var-file prod.tfvars`

   - Remove line bot

   - Remove Github personal access token