Skip to content

Commit 09dee3c

Browse files
authored
Update README.md
1 parent 0cdc4c8 commit 09dee3c

1 file changed

Lines changed: 74 additions & 4 deletions

File tree

README.md

Lines changed: 74 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,75 @@
1-
# tellingme-python-server
1+
# TellingMe
22

3-
### How to run the server
4-
1. build docker image `docker build -t tellingme-python-server .`
5-
2. run docker container `docker run -d -p 8000:8000 --name tellingme-python-server tellingme-python-server`
3+
**나를 깨닫는 시간, 텔링미 💚**
4+
TellingMe는 바쁜 현대인들이 하루에 한 번, 스스로를 돌아볼 수 있도록 도와주는 감성 기반 자기 탐색 서비스입니다.
5+
매일 저녁 6시, 텔링미는 새로운 질문을 전송합니다. 사용자는 그날의 질문에 답하며 자신의 감정을 기록하고, 나만의 공간에서 일상의 감정을 정리할 수 있습니다.
6+
7+
---
8+
9+
## 🚀 Features
10+
11+
### ✅ v1 기능 (자기 탐색 및 감정 기록)
12+
13+
- 📮 **오늘의 질문**: 매일 18시에 새로운 질문 전송
14+
- 🧠 **감정 분석**: 답변 기반 감정 인식 및 히스토리 확인
15+
- 📓 **나의 공간**: 개인 답변 기록 및 정리
16+
- 🫂 **모두의 공간**: 감정 공유를 통한 공감 커뮤니티
17+
18+
---
19+
20+
### 🆕 v2 기능 (UX 향상 및 인앱 결제 시스템)
21+
22+
- 🃏 **텔러카드 생성 및 꾸미기**
23+
- 🧀 **치즈(Cheese) 결제 시스템**
24+
- 💬 **감정 구매 기능**
25+
- 🎯 **미션 시스템**: 일일/주간 보상 기반 서비스 이용 유도
26+
27+
---
28+
29+
## 🛠️ Tech Stack
30+
31+
### Language & Framework
32+
- **Language**: Python
33+
- **Framework**: FastAPI
34+
- **ORM**: Tortoise ORM
35+
36+
### Asynchronous Task Queue
37+
- **Task Queue**: Celery
38+
- **Broker/Backend**: Redis
39+
40+
### Testing & Linting
41+
- **Test Framework**: Pytest
42+
- **Linting**: Ruff, Black, dmypy
43+
- **CI Rule**: 테스트 커버리지가 90% 이상을 만족하지 않으면 병합 불가
44+
45+
### CI/CD
46+
- GitHub Actions 기반
47+
- **CI**: 커버리지 체크, 린팅, 테스트 자동 실행
48+
- **CD**: AWS 인프라를 통한 자동 배포 (무중단 블루/그린 배포)
49+
50+
### Infrastructure
51+
- **Cloud**: AWS
52+
- **Components**:
53+
- Route53 (DNS)
54+
- Application Load Balancer
55+
- EC2 (배포 대상 서버)
56+
- RDS (Relational Database)
57+
- Redis (Celery 백엔드용)
58+
59+
---
60+
61+
## 🧱 Architecture
62+
63+
```plaintext
64+
Client
65+
66+
[ Route53 ]
67+
68+
[ Load Balancer ]
69+
↓ ┌────────────┐
70+
[ Target Group ] ───▶ │ EC2-A │
71+
│ (App v1) │
72+
[ Target Group ] ───▶ │ EC2-B │
73+
│ (App v2) │
74+
↓ └────────────┘
75+
[ RDS (MySQL) ]

0 commit comments

Comments
 (0)