Lunary 🌙

From Chats to Chapters
나만의 AI 일기장 - 루나리(Lunary)

🌟 프로젝트 소개

Lunary는 사용자의 감정을 이해하고 기록하는 AI 기반 감성 일기장 앱입니다.
사용자와 AI간 채팅을 바탕으로 자동으로 일기와 감정 분석 및 리뷰를 생성합니다. 일상을 돌아보고 감정을 성찰하며, 나만의 이야기로 하루를 마무리할 수 있습니다.

✨ 주요 기능

• 💬 AI 채팅: 사용자와 AI간 채팅.
• 📖 AI 일기: 채팅 내용을 바탕으로 일기 자동 작성
• 📊 AI 리뷰: 감정 상태 그래프, AI의 오늘의 조언 제공
• 📅 달력 UI: 대화 및 일기/리뷰 기록 확인

🛠️ 프로젝트 구조

• Frontend: Flutter
• Backend: Firebase (Authentication, Firestore)
• AI 기능: OpenAI API
• 디자인: Flutter Material Widget
• 주요 디렉토리:

lib/
├─models # 데이터 모델 클래스
├─screens # 앱 주요 화면
│  ├─auth
│  ├─chat
│  ├─diary
│  └─home
├─services # Firebase 및 OpenAI API
├─utils # 유틸
└─widgets # 공통 위젯 혹은 부수적인 위젯
    ├─auth
    ├─calendar
    ├─chat
    ├─diary
    └─profile
asset/ # 이미지 등 기타 파일

🚀 설치 및 실행

1. 안드로이드 전용 APK 설치

추후 제공 예정

2. 직접 빌드

1. 프로젝트 클론

git clone https://github.com/Lunary-AI-Diary/Lunary.git
cd lunary

2. 패키지 설치

flutter pub get

3. Firebase API 설정

• 프로젝트에 개인 Firebase 설정 초기화

# 아래 세 파일을 따로 준비하세요
Lunary/
└─android/
    └─app
        └─ google-services.json
└─lib/
    └─firebase_options.dart
└─firebase.json

4. OpenAI API 설정

• .env 환경변수 파일을 만들기

Lunary/
└─.env

• OpenAI API 키 준비 및 입력

# .env
OPENAI_API_KEY=your_openai_api_key

5. 앱 실행

flutter run

🤝 Contributing

We welcome contributions from everyone! Whether you are fixing bugs, improving features, or suggesting new ideas, your help is appreciated. To contribute to Lunary, please follow these steps:

1. Fork the repository
   Click the "Fork" button at the top-right corner of this repository to create your own copy.

2. Create a branch
   Name your branch clearly according to the feature or fix you are working on.

   git checkout -b feature/your-feature

3. Make Changes & Commit

   git add .
   git commit -m "Add some feature"

4. Push to your forked repository

   git push origin feature/your-feature

5. Create a Pull Request
   Go to the original Lunary repository and open a Pull Request. Describe your changes clearly so reviewers can understand your contribution.

✨ Tips:

Feel free to open an issue first if you want to discuss your idea before implementing it. Everyone’s contribution is valued, no matter how big or small!

License

This project is licensed under the MIT License - see the LICENSE file for details.

Trademark

"Lunary" name and logo are claimed as brand identifiers of this project.
You may not use the "Lunary" name or logo in a way that suggests official affiliation without prior written permission. See the TRADEMARK.md file for more details.