TODO REALとは

TODO REALは、TODOリストをSNSのように共有できるようにすることで、目標やタスクの達成を効果的かつ継続的にサポートするWebアプリケーションです。

アプリの使用方法や特徴、詳細については、トップページを参照してください。

TODO REAL トップページ

ローカルで開発する手順

開発にはFirebaseプロジェクトもしくは権原が必要です。

フロントエンドを起動

npm run dev

このコマンドはnpm iとnext devを含んでいます。 Next.jsに関しては公式サイトや公式ドキュメントを参照してください。

バックエンドを起動

初回のみ以下のコマンドを実行

npm install -g firebase-tools
firebase login

エミュレーターを起動(ローカルでは認証やデータベース、API等全てのサーバーサイドの機能をエミュレーターで実行します。)

cd .\functions\
npm run emu

npm run emuはnpm i, firebase emulators:start, npx tsc --watchを含んでいます。ファイルに変更があった場合にはAPIを自動で再起動します。

ファイル変更時に自動で再起動をしない場合は次のコマンドを実行してください。

firebase emulators:start

技術的なドキュメント

このプロジェクトはフロントエンドにTypeScript, Next.jsを使用し、バックエンドにTypeScript, Node.js, Firebaseを使用しています。
技術的な実装方法や仕様に関しては以下のドキュメントを参照してください。

	このプロジェクト内のドキュメント/関連するPR	Firebase/Google Cloudの公式ドキュメント
API	API Document	Cloud Functions for Firebase
データベース	Database Document	Cloud Firestore
ストレージ		Cloud Storage for Firebase
認証	PR: ログイン機能をFirebase Authenticationに接続 #39	Firebase Authentication
通知を受信	PR: Cloud Messagingを実装 #49	Firebase Cloud Messaging
スケジューラー/通知を送信	PR: 期限が近い目標にCloud Tasksで通知を送信する機能を実装 #100	Cloud Tasks in Google Cloud
セキュリティ	PR: App CheckとAnalyticsの導入 #84	Firebase App Check
ログ		Cloud Logging