10/09 배포

.github/workflows/firebase-hosting-merge.yml

@@ -0,0 +1,27 @@
+# This file was auto-generated by the Firebase CLI
+# https://github.com/firebase/firebase-tools
+
+name: Deploy to Firebase Hosting on merge
+on:
+  push:
+    branches:
+      - main
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 10
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'pnpm'
+      - run: "pnpm install --frozen-lockfile && pnpm -r run build "
+      - uses: FirebaseExtended/action-hosting-deploy@v0
+        with:
+          repoToken: ${{ secrets.GITHUB_TOKEN }}
+          firebaseServiceAccount: ${{ secrets.FIREBASE_SERVICE_ACCOUNT_TIL_ALARM }}
+          channelId: live
+          projectId: til-alarm

.github/workflows/firebase-hosting-pull-request.yml

@@ -0,0 +1,28 @@
+# This file was auto-generated by the Firebase CLI
+# https://github.com/firebase/firebase-tools
+
+name: Deploy to Firebase Hosting on PR
+on: pull_request
+permissions:
+  checks: write
+  contents: read
+  pull-requests: write
+jobs:
+  build_and_preview:
+    if: ${{ github.event.pull_request.head.repo.full_name == github.repository }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 10
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'pnpm'
+      - run: "pnpm install --frozen-lockfile && pnpm -r run build "
+      - uses: FirebaseExtended/action-hosting-deploy@v0
+        with:
+          repoToken: ${{ secrets.GITHUB_TOKEN }}
+          firebaseServiceAccount: ${{ secrets.FIREBASE_SERVICE_ACCOUNT_TIL_ALARM }}
+          projectId: til-alarm

.gitignore

@@ -1,15 +1,15 @@
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
 # dependencies
-/node_modules
-/.pnp
-.pnp.js
+node_modules
 
 # testing
 /coverage
 
 # production
-/build
+app/dist
+functions/dist
+packages/shared/dist
 
 # misc
 .DS_Store
@@ -19,6 +19,9 @@
 .env.production.local
 
 npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-.env
+.env
+!.env.example
+
+# firebase
+.firebase/
+firebase-debug.log*

README.md

@@ -1,32 +1,201 @@
-# today-i-learned-alarm
-에빙하우스 망각곡선(1일, 7일, 30일)에 의거하여 공부한 내용을 매일 아침 PUSH 알림을 받을 수 있도록 해주는 프로그램
-<br><br>
-<div align=center>
-    <img src="./public/til-alram.gif" width=200>
-</div>
+# RecallBuddy
 
-<br/>
+매일 학습한 내용을 정리하고 알림을 받는 앱입니다.
 
-## 기술 스택
+## 🚀 빠른 시작
 
-<div align=left>
-  <img src="https://img.shields.io/badge/react v18-61DAFB?style=for-the-badge&logo=React&logoColor=white">
-  <img src="https://img.shields.io/badge/PWA-5A0FC8?style=for-the-badge&logo=PWA&logoColor=white">
-  <img src="https://img.shields.io/badge/Firebase-FFCA28?style=for-the-badge&logo=Firebase&logoColor=black">
-  <img src="https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=GitHub&logoColor=white">
-  <img src="https://img.shields.io/badge/Markdown-000000?style=for-the-badge&logo=Markdown&logoColor=white">
-</div>
-<br>
+### 1. 환경 설정
+```bash
+# Firebase 프로젝트 정보를 사용해 app/.env에 Functions 프록시 주소 생성/추가
+pnpm env:setup
 
-## 기술 블로그
+# (옵션) 수동 설정 시 app/.env에 다음 키들을 추가하세요
+# Firebase Web 설정 (Console > 프로젝트 설정 > 일반 > 웹 앱 구성에서 복사)
+VITE_API_KEY=...
+VITE_AUTH_DOMAIN=...
+VITE_PROJECT_ID=...
+VITE_STORAGE_BUCKET=...
+VITE_MESSAGING_SENDER_ID=...
+VITE_APP_ID=...
+VITE_MEASUREMENT_ID=...
 
-- [안드로이드, IOS 지식 없이 SENS로 알림(PUSH) 서비스 개발하기](https://chucoding.tistory.com/129)
-- [네이버클라우드 서비스를 활용한 알림(PUSH) 앱 배포하기](https://chucoding.tistory.com/130)
+# Functions 호출용 (`pnpm proxy`로 자동 추가)
+VITE_FIREBASE_PROJECT_ID=
+VITE_FIREBASE_REGION=
+VITE_FUNCTIONS_URL_LOCAL=
+VITE_FUNCTIONS_URL_PROD=
+```
 
+### 2. 개발 서버 시작
+```bash
+pnpm dev
+```
 
-<br>
+### 3. Firebase Functions 설정
+```bash
+cd functions
 
-## 라이센스
+# 환경변수 설정 (로컬 개발용)
+echo "GITHUB_TOKEN=your_github_token_here" > .env
 
-<a href="https://www.linkedin.com/in/chucoding/" target="_blank">Prod By. 외계공룡</a><br/>
-Copyright &copy; today-i-learned-alarm<br/>All Rights Reserved.</p>
+# Functions 실행
+pnpm serve
+```
+
+## 📁 프로젝트 구조
+
+```
+├── app/                    # React 앱 (프론트엔드)
+│   ├── src/
+│   │   ├── api/           # API 호출 함수들
+│   │   ├── modules/       # 유틸리티 (axios 등)
+│   │   └── pages/         # 페이지 컴포넌트들
+│   └── vite.config.ts     # Vite 설정 (프록시 포함)
+├── functions/              # Firebase Functions (백엔드)
+│   ├── src/
+│   │   ├── github.ts      # GitHub API Functions
+│   │   ├── schedule.ts    # 스케줄러 Functions
+│   │   └── hypercloax.ts  # Hypercloax API Functions
+│   └── package.json
+└── scripts/
+    └── setup-proxy.js     # app/.env에 Functions URL 자동 추가/보강 스크립트
+```
+
+## 🔧 환경변수
+
+### 앱 환경변수 (app/.env)
+```bash
+# Firebase Web 설정 (콘솔에서 복사)
+VITE_API_KEY=...
+VITE_AUTH_DOMAIN=...
+VITE_PROJECT_ID=...
+VITE_STORAGE_BUCKET=...
+VITE_MESSAGING_SENDER_ID=...
+VITE_APP_ID=...
+VITE_MEASUREMENT_ID=...
+
+# Functions 호출 설정 (`pnpm proxy` 실행 시 자동 추가)
+VITE_FIREBASE_PROJECT_ID=
+VITE_FIREBASE_REGION=
+VITE_FUNCTIONS_URL_LOCAL=
+VITE_FUNCTIONS_URL_PROD=
+```
+
+### Functions 환경변수 (functions/.env)
+```bash
+CLOVA_API_KEY=your_clova_api_key
+```
+
+## 🌏 리전 설정
+
+이 프로젝트는 기본적으로 **Seoul (asia-northeast3)** 리전에 배포됩니다.
+
+### 사용 가능한 Firebase Functions 리전
+- `asia-northeast3` - Seoul (서울) ⭐ 기본값
+- `asia-northeast1` - Tokyo (도쿄)
+- `us-central1` - Iowa (아이오와)
+- `us-west1` - Oregon (오레곤)
+- `europe-west1` - Belgium (벨기에)
+- [전체 리전 목록](https://firebase.google.com/docs/functions/locations)
+
+### 리전 변경 방법
+
+다른 리전으로 변경하려면 다음 파일들을 수정하세요:
+
+#### 1. Functions 코드 (모든 함수의 region 옵션 수정)
+
+**`functions/src/github.ts`**
+```typescript
+export const getCommits = onRequest(
+  { cors: true, region: 'your-region' },  // 변경
+  async (req, res) => { ... }
+);
+// getFilename, getMarkdown, getRepositories, getBranches도 동일하게 수정
+```
+
+**`functions/src/hyperclovax.ts`**
+```typescript
+export const chatCompletions = onRequest(
+  { cors: true, region: 'your-region' },  // 변경
+  async (req, res) => { ... }
+);
+```
+
+**`functions/src/schedule.ts`**
+```typescript
+export const sendDaily8amPush = onSchedule(
+  {
+    schedule: '0 23 * * *',
+    timeZone: 'Asia/Seoul',
+    region: 'your-region'  // 변경
+  },
+  async () => { ... }
+);
+```
+
+#### 2. Setup 스크립트 (환경변수 자동 생성용)
+
+**`scripts/setup-proxy.js`**
+```javascript
+const envVars = {
+  VITE_FIREBASE_PROJECT_ID: projectId,
+  VITE_FIREBASE_REGION: 'your-region',  // 변경
+  VITE_FUNCTIONS_URL_LOCAL: `http://localhost:5001/${projectId}/your-region`,  // 변경
+  VITE_FUNCTIONS_URL_PROD: `https://your-region-${projectId}.cloudfunctions.net`  // 변경
+};
+```
+
+#### 3. 환경변수 재생성
+
+```bash
+# setup 스크립트 재실행하여 app/.env 업데이트
+pnpm env:setup
+```
+
+## 🚀 배포
+
+### Functions 개별 배포
+```bash
+cd functions
+
+# GitHub API만 배포
+pnpm deploy:github
+
+# Schedule만 배포
+pnpm deploy:schedule
+
+# Hypercloax만 배포
+pnpm deploy:hypercloax
+
+# 전체 배포
+pnpm deploy
+```
+
+### 앱 배포
+```bash
+# 루트에서 전체 배포
+pnpm deploy
+```
+
+## 🔄 API 구조
+
+### GitHub API
+- `GET /api/getCommits?since={date}&until={date}` - 커밋 목록
+- `GET /api/getFilename?commit_sha={sha}` - 커밋 상세
+- `GET /api/getMarkdown?filename={filename}` - 마크다운 내용
+
+### Hypercloax API
+- `POST /api/chatCompletions` - CLOVA Studio 질문 생성
+- `POST /api/registerDeviceToken` - FCM 토큰 등록
+- `POST /api/removeDeviceToken` - FCM 토큰 삭제
+- `POST /api/registerSchedule` - 스케줄 등록
+
+### Schedule
+- 자동 실행 (매일 오전 8시 KST)
+
+## 🛠️ 개발 도구
+
+- **프론트엔드**: React + TypeScript + Vite
+- **백엔드**: Firebase Functions + TypeScript
+- **API 통신**: Axios
+- **배포**: Firebase Hosting + Functions

app/.env.example

@@ -0,0 +1,19 @@
+# Firebase auth
+VITE_API_KEY=your_firebase_api_key_here
+VITE_AUTH_DOMAIN=your_project.firebaseapp.com
+VITE_PROJECT_ID=your_project_id
+VITE_STORAGE_BUCKET=your_project.appspot.com
+VITE_MESSAGING_SENDER_ID=your_sender_id
+VITE_APP_ID=your_app_id
+VITE_MEASUREMENT_ID=your_measurement_id
+VITE_VAPID_KEY=your_vapid_key_here
+
+# Firebase Functions (pnpm proxy 실행시 자동 생성)
+VITE_FIREBASE_PROJECT_ID=
+VITE_FIREBASE_REGION=
+VITE_FUNCTIONS_URL_LOCAL=
+VITE_FUNCTIONS_URL_PROD=
+
+# 사용자 설정
+VITE_USER_ID=your_user_id_here
+VITE_SCHEDULE_CODE=your_schedule_code_here

app/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="ko">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/x-icon" href="/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>RecallBuddy</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

app/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "app",
+  "private": true,
+  "version": "2.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build"
+  },
+  "dependencies": {
+    "@recall-buddy/shared": "workspace:*",
+    "axios": "^1.12.2",
+    "firebase": "^10.4.0",
+    "github-markdown-css": "^5.8.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-indexed-db-hook": "^1.0.14",
+    "react-markdown": "^9.0.0",
+    "react-slick": "^0.30.2",
+    "react-syntax-highlighter": "^15.5.0",
+    "remark-gfm": "^4.0.0",
+    "slick-carousel": "^1.8.1",
+    "zustand": "^5.0.8"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.0",
+    "@types/react-dom": "^18.2.0",
+    "@types/react-slick": "^0.23.13",
+    "@types/react-syntax-highlighter": "^15.5.11",
+    "@vitejs/plugin-react": "^4.0.0",
+    "typescript": "^5.0.0",
+    "vite": "^5.0.0",
+    "vite-plugin-pwa": "^0.17.0"
+  }
+}