From 7f0bb2f7316cf67d7f1a92b07c2693577eb7beea Mon Sep 17 00:00:00 2001 From: toshi0607 Date: Sat, 29 Aug 2020 21:52:31 +0900 Subject: [PATCH] :memo: Add README --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6f8676f --- /dev/null +++ b/README.md @@ -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)