Skip to content

foodbank-ymg/thanks-web-backend

Repository files navigation

thanks-web-backend

フードバンクありがとう Website のバックエンドです。おたよりの投稿フローとデータを管理しています。

https://thankyou.fbyamaguchi.org/

Important

Web サイトはフロントエンド側で管理しています。 実際にサービスとして提供するには、フロントエンドを含めた Web 環境の構築が必要です。

https://github.com/foodbank-ymg/thanks-web-frontend/

ローカル環境

LINE 公式アカウントを使います。Messaging API のチャネルを 2 つ(投稿側/管理側)作成します。

.env.boilerplate をコピーして .env ファイルを作成し、各種シークレット変数を設定してください。

Nodejsyarn をインストールしてください。

依存パッケージをインストールした後、ローカル実行します。

yarn
yarn start

http://localhost:8080 で API サーバーが起動します。

LINE の疎通と検証を行うには、ngrokなどを用いてローカルネットワークを外部公開してください。

Web サービス環境

GCP の Cloud Run と Cloud Storage を使います。

GCP はFirebaseを内包しているので、Firebase プロジェクトを作成していれば、既に GCP プロジェクトを扱うことができます。

2 つの GCP/Firebase 環境(開発用/本番用)を前提とした GitHub Actions の自動リリースを組んでいます。

  • developブランチにマージすると、開発環境に自動リリース
  • mainブランチにマージすると、本番環境に自動リリース

Firebase/GCP が準備できたら、GitHub Actions に各種シークレット変数を登録してください。

ライセンス

このプロジェクトは GNU Affero General Public License v3.0(AGPL-3.0)の条件の下でライセンスされています。

詳細については、このリポジトリのLICENSEファイルをご覧ください。

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages