https://github.com/k2tzumi/pic-search-slash-command

https://github.com/k2tzumi/pic-search-slash-command

gas hacktoberfest slack-bot

Last synced: 13 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/k2tzumi/pic-search-slash-command
• Owner: k2tzumi
• Created: 2020-06-14T00:36:19.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T05:00:47.000Z (almost 2 years ago)
• Last Synced: 2024-10-27T17:05:30.481Z (2 months ago)
• Topics: gas, hacktoberfest, slack-bot
• Language: TypeScript
• Homepage:
• Size: 1.11 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![clasp](https://img.shields.io/badge/built%20with-clasp-4285f4.svg)](https://github.com/google/clasp)

![ci](https://github.com/k2tzumi/pic-search-slash-command/workflows/ci/badge.svg)

What is this?

==============================

 This bot executes the slack slash command to search for images.  

 This bot runs as a web app within a Google app script.  

You can make this bot work by registering it as a request URL for the [Slack API](https://api.slack.com/apps) slash command.

 

REQUIREMENTS

--------------------

- `npm`

- [clasp](https://github.com/google/clasp)  

`npm install -g @google/clasp`

- `make`

USAGE

--------------------

To use it, you need to set up Google apps scripts, Custom Search API and Slack API.

### Install Google apps scripts

1. Enable Google Apps Script API  

https://script.google.com/home/usersettings

2. make push  

3. make deploy  

4. Grant the necessary privileges  

make open  

Publish > Deploy as web app.. > Update  

Grant access

### Register with the Slack API

* Create New App  

https://api.slack.com/apps  

Please make a note of `App Credentials` displayed after registration.

### Setting Script properties

In order to run the application and change its behavior, you need to set the following Google Apps scripts property.

|Property name|Required|Setting Value|Description|

|--|--|--|--|

|VERIFICATION_TOKEN|○|Basic Information > App Credentials > Verification Token|A token that easily authenticates the source of a hooked request|

|GOOGLE_API_KEY|○|[Create Credentials](https://console.cloud.google.com/apis/credentials)||

|CUSTOM_SEARCH_ENGINE_ID|○|Enabling the Custom Search API. Getting the Custom Search Engine (CSE)||

|OVERUSE_MESSAGE||default `:anger: Search too much..`||

1. Open Project  

`$ make open`

2. Add Scirpt properties  

File > Project properties > Scirpt properties > Add row  

Setting Property & Value

### Settings Slash Commands & Slack APP install

* Create New Command  

Setting Request URL.

ex) https://script.google.com/macros/s/miserarenaiyo/exec  

* Slack APP install

Settings > Install App