Skip to content

eikophys/Clubroom

Repository files navigation

Deploy to Firebase Hosting on merge

branch CI status
main Node.js CI
develop Node.js CI

Clubroom

物理研究部出欠管理システム Clubroom

構成

システム構成図

フロントエンド

  • React
    • JavaScript フレームワーク
    • HTML の生成に利用
  • Chakra UI
    • 主に UI コンポーネントに使用
  • Vite
    • ビルドに使用

バックエンド

  • Cloudflare Pages
    • ページの配信に使用
    • Firebase Hosting の方が優秀な可能性あり
  • Firestore
    • データの保管に使用
  • Firebase Authentication
    • ユーザー認証に使用

開発

管理者の方はメールアドレスを記載の上で[email protected]までご連絡ください。
管理を行ってくれる方も探しています。
本アプリは Node.js を用いて開発されています。

開発サーバーの起動

# npm run dev
yarn dev

仮想環境(エミュレーター)の起動

# npm run preview
yarn preview

データ等も含めて起動します

環境変数

以下の通り環境変数を設定してください。
環境変数は.envファイルを現在のディレクトリに置くことで設定されます

VITE_FIREBASE_API_KEY = <firebase api key>
VITE_FIREBASE_APP_ID = <firebase のapp id>
VITE_FIREBASE_MEASUREMENT_ID = <firebaseのmeasurement id>
VITE_FIREBASE_PROJECT_ID = <firebaseのproject id>