Skip to content

Commit

Permalink
📝 Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
toshi0607 committed Aug 29, 2020
1 parent 608188f commit 7f0bb2f
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# KompalWeather

## What is KompalWeather?

KompalWeather reports on how crowded kompal-yu is on Twitter ([@KompalWeather](https://twitter.com/KompalWeather)) and Slack.

[Kompal-yu (金春湯)](https://kom-pal.com/) is one of the best saunas and public bathes in Osaki. They are disclosing how crowded it is on their site. Furthermore, they provide API. KompalWeather utilizes this API.

Take advantage of kompal weather to optimize your sauna experience!

## Features

### Existing

* Notification about the state of congestion on
* Twitter [@KompalWeather](https://twitter.com/KompalWeather)
* Slack channel via incoming webhook)
* Record data in out Google Sheets every 15 minutes during business hours

### Plan

* Visualization of weekly congestion

If you have a feature request, please make an issue from [here](https://github.com/toshi0607/KompalWeather/issues/new)!

## Architecture

### Cloud

* Cloud Run
* Cloud Scheduler
* Secret Manager
* Cloud Build

![image dependency](./terraform/development/kompal-graph.jpg)

Managed by [Terraform](https://github.com/toshi0607/KompalWeather/tree/master/terraform/development)

0 comments on commit 7f0bb2f

Please sign in to comment.