Files
zellyy-finance/docs/README.md

60 lines
2.9 KiB
Markdown

# Zellyy Finance 프로젝트 문서
이 디렉토리는 Zellyy Finance 프로젝트의 모든 문서를 체계적으로 정리한 곳입니다. 사용자들이 개인 재정을 효과적으로 관리하고 적자 상태에서 벗어날 수 있도록 도와주는 모바일 앱입니다.
## 프로젝트 개요
'Zellyy Finance'는 단순한 수입/지출 기록을 넘어, 사용자의 소비 패턴을 분석하고 맞춤형 절약 전략을 제안하여 재정 건전성을 개선하는 데 중점을 둔 모바일 앱입니다. Appwrite 백엔드를 활용하여 안정적인 데이터 관리와 인증 시스템을 제공합니다.
## 폴더 구조
### 00_프로젝트_개요
프로젝트의 기본 개요와 목표, 사용자 정의에 관한 문서가 포함되어 있습니다.
- `프로젝트_소개.md` - 프로젝트 개요 및 주요 기능 설명
- `핵심_문제_정의.md` - 해결하고자 하는 문제 정의
- `사용자_페르소나.md` - 타겟 사용자 프로필
### 01_기획_및_설계
프로젝트의 기획 및 UI/UX 설계에 관한 문서가 포함되어 있습니다.
- `요구사항_분석.md` - 사용자 요구사항 및 기능적/비기능적 요구사항 분석
- `UI_와이어프레임.md` - 핵심 화면 와이어프레임
- `사용자_경험_전략.md` - 사용자 경험 설계 전략
### 02_기술_문서
프로젝트의 기술적 구현에 관한 문서가 포함되어 있습니다.
- `시스템_아키텍처.md` - 시스템 아키텍처 설계 문서
- `데이터_모델_설계.md` - 데이터베이스 스키마 및 모델 설계
- `Appwrite_전환_가이드.md` - Supabase에서 Appwrite로의 전환 가이드
### 03_개발_단계
개발 과정과 관련된 문서가 포함되어 있습니다.
- `개발_가이드라인.md` - 코드 작성 원칙, iOS/Android 지원, Appwrite 통합 등에 관한 가이드라인
### archive
더 이상 활발하게 사용되지 않는 레거시 문서들이 보관되어 있습니다.
- `Supabase 관련 문서` - 이전에 사용하던 Supabase 관련 설정 및 가이드
- `개발 단계별 문서` - 이전 개발 단계의 계획 및 산출물 요약
## 주요 기술 스택
- **프론트엔드**: React Native, TypeScript
- **백엔드**: Appwrite
- **상태 관리**: Context API
- **UI 컴포넌트**: Lovable UI
- **네이티브 통합**: Capacitor
## 개발 가이드라인
개발 가이드라인은 [03_개발_단계/개발_가이드라인.md](./03_개발_단계/개발_가이드라인.md) 문서를 참조하세요. 이 문서에는 다음 내용이 포함되어 있습니다:
1. 코드 작성 원칙
2. 트랜잭션 삭제 안전성
3. Appwrite 통합 원칙
4. 상태 관리 최적화
5. iOS/Android 지원
6. 디버깅 및 로깅
## Appwrite 전환
Supabase에서 Appwrite로의 전환에 관한 상세 정보는 [02_기술_문서/Appwrite_전환_가이드.md](./02_기술_문서/Appwrite_전환_가이드.md) 문서를 참조하세요.