https://github.com/bcongdon/git-haiku-bot
☯️ Git Commit Haikus in Tweet form
https://github.com/bcongdon/git-haiku-bot
aws-lambda github haiku javascript twitter-bot
Last synced: 2 months ago
JSON representation
☯️ Git Commit Haikus in Tweet form
- Host: GitHub
- URL: https://github.com/bcongdon/git-haiku-bot
- Owner: bcongdon
- License: mit
- Created: 2017-03-22T22:35:10.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-29T08:36:09.000Z (about 9 years ago)
- Last Synced: 2025-06-16T03:37:58.171Z (about 1 year ago)
- Topics: aws-lambda, github, haiku, javascript, twitter-bot
- Language: JavaScript
- Homepage: https://twitter.com/GitHaiku
- Size: 23.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# git-haiku-bot
> ☯️ Git Commit Haikus in Tweet form
See it in action: https://twitter.com/GitHaiku
## Configuration
1. Copy the `.env` template
```
cp .env.template .env
```
2. [Create](https://apps.twitter.com/) a Twitter app and note your credentials.
3. Use the credentials from the last step to fill in the following fields in `.env`:
* `CONSUMER_KEY`
* `CONSUMER_SECRET`
* `ACCESS_TOKEN`
* `ACCESS_TOKEN_SECRET`
## Usage
### Local Usage
First, install dependencies:
```
npm install
```
Local usage:
```
Usage: git-haiku-bot [options] [command]
Commands:
generate Generates a haiku
post Posts a git haiku
Options:
-h, --help output usage information
```
Example:
```
$ ./git-haiku-bot generate
Number of features
What changes were proposed
The keys times out when
via apache/spark
```
### AWS Lambda Deployment
1. Build the .zip package:
```
npm run package
```
2. Upload `./build/git-haiku-bot.zip` to Lambda
3. Setup a CloudWatch Schedule with a `rate(1 hour)` activation schedule.