Civichat Chatbot

これは何

CivichatのChatbot部分の機能をもったリポジトリです。

これらは過去には2つのリポジトリが分かれていました。(Civichat/Civichat_Kumamoto と Civichat/civichat-kumamoto-for-twitter )

しかし、両リポジトリ間での重複がとても大きかったので、Typescriptへの移行に伴って、実装を統合しています。

AWS->Heroku->AWSとデプロイ先を変えていったため、各サービスの設定ファイルが残っています。

LIFFに関してはCivichat/Civichat-chatbot-frontを参照してください。

ブランチルール

• 原則 Git-flow に従います。

  • A successful Git branching model » nvie.com
  • 日本語訳 A successful Git branching model - Qiita

• ただし、releaseブランチは原則使わない方向で考えています（@yuseiito）

  • これは、すでに元記事が公開されてから10年以上経過しているGit-flowは継続的デリバリーを前提としておらず（発案者もそれ言及しています）、今となってはただ複雑にしている道具になっているからです
  • リリースは、developからmainへのマージとmain上でのtagによって表現できます。

• 新機能の開発を進めるときは、developから新しいブランチfeature/#[issue_number]-some-descriptive-nameを生やしてください。

  • ケバブケースにしてください
    • 参照: agis/git-style-guide: A Git Style Guide
  • 検索しにくいのでできるだけissueを生やすと良いです。
    • issueを生やさない場合はfeature/some-descriptive-nameな感じの名前になります。
      • とても短い、小規模な変更等に限って使うのがいいです

• 開発が終わったら、developに対してPull Requestしてください。

  • Pull Requestは、エンジニア1人以上のコードレビューを受けてmergeできます。

• 現在は株式会社Civichatのメンバーのみがマージすることができます。

技術スタック

• TypeScript
• AWS AppRunner
• PostgreSQL

必要なもの

• LINE Developer Account
• AWS Account

環境構築

ローカル

• env .env.sampleを参考に作成する

• LINEBot ngrokを使い、ローカルでLINEBotを作成します

npm install

npm run build:dev

別タブ

node dist/index.js

別タブ

ngrok http 5000

• データベース

docker-compose up

• ngrokを実行して表示されたURLに/lineをパスに追加してLINE Developer Consoleで登録してください。
  • この際にWebhookも有効にしてください。