Skip to content

Commit 5a4e27e

Browse files
authored
add: README.md 최종본 main 브랜치에 반영
add: README.md 최종본 main 브랜치에 반영
2 parents c1c2aaa + 564d5d6 commit 5a4e27e

19 files changed

+192
-1
lines changed

README.md

Lines changed: 187 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,187 @@
1-
# On-Record
1+
# 📝 On-Record(온기록)
2+
### 🍀 피로그래밍 22기 최종 프로젝트
3+
📆 **개발 기간**: 2025년 01월 27일 ~ 2025년 02월 18일
4+
### 📂 Contents
5+
1. [☀️ 서비스 소개](#-서비스-소개)
6+
2. [💻 사용 툴](#-사용-툴)
7+
3. [📈 Flowchart](#-Flowchart)
8+
4. [🧱 System Architecture](#-System-Architecture)
9+
5. [📀 ERD](#-ERD)
10+
6. [🐶 팀원 소개](#-팀원-소개)
11+
12+
13+
## ☀️ 서비스 소개
14+
![온기록 로고](static/images/readme/onrecord_logo(readme).png)
15+
> #### URL: ["온기록 사이트"](onrecord.kr, "온기록 이용해보기")
16+
> 반려동물이나 반려식물과의 추억을 기록하면, **AI**가 반려친구의 입장에서 답장을 생성해주는 웹서비스
17+
18+
19+
온기록(온기 + 기록)은 반려동물 또는 반려식물을 키우는 사용자들이 자신의 반려친구와의 소중한 일상을 기록할 수 있도록 돕는 웹 서비스입니다.
20+
반려동물뿐만 아니라 반려식물도 포함하여 보다 폭넓은 사용자층을 대상으로 하며, 감정과 날씨 등의 요소를 활용해 일상을 더욱 생동감 있게 기록할 수 있도록 설계되었습니다.
21+
22+
23+
## 💻 사용 툴(Tools)
24+
25+
******
26+
27+
#### Front-End
28+
<p>
29+
<img src="https://img.shields.io/badge/HTML-239120?style=for-the-badge&logo=html5&logoColor=white"/>
30+
<img src="https://img.shields.io/badge/CSS-1572B6?style=for-the-badge&logo=css3&logoColor=white"/>
31+
<img src="https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black"/>
32+
</p>
33+
34+
35+
******
36+
37+
38+
#### Back-End
39+
<p>
40+
<img src="https://img.shields.io/badge/Django-092E20?style=for-the-badge&logo=django&logoColor=green">
41+
<img src="https://img.shields.io/badge/PostgreSQL-316192?style=for-the-badge&logo=postgresql&logoColor=white">
42+
<img src="https://img.shields.io/badge/Nginx-009639?style=for-the-badge&logo=nginx&logoColor=white">
43+
<img src="/static/images/readme/gunicorn.png">
44+
<img src="https://img.shields.io/badge/GitHub_Actions-2088FF?style=for-the-badge&logo=github-actions&logoColor=white">
45+
<img src="/static/images/readme/navercloud.png">
46+
</p>
47+
48+
49+
******
50+
51+
52+
#### AI
53+
<p>
54+
<img src="https://img.shields.io/badge/ChatGPT-74aa9c?style=for-the-badge&logo=openai&logoColor=white">
55+
</p>
56+
<br>
57+
58+
**AI 답변 생성 방식**
59+
> - OpenAI의 **GPT 모델**을 사용하여 사용자의 일기에 대한 답변을 생성
60+
> - 작성한 일기와 반려친구의 정보 데이터를 반영하여 맞춤형 AI 응답 제공
61+
62+
63+
******
64+
65+
66+
### 🌟 협업 툴
67+
<p>
68+
<img src="https://img.shields.io/badge/GIT-E44C30?style=for-the-badge&logo=git&logoColor=white">
69+
<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">
70+
<img src="https://img.shields.io/badge/Notion-000000?style=for-the-badge&logo=notion&logoColor=white">
71+
<img src="https://img.shields.io/badge/Figma-F24E1E?style=for-the-badge&logo=figma&logoColor=white">
72+
</p><br>
73+
74+
> [🐶 온기록 피그마](https://www.figma.com/design/UegG1gocuWCnORJeMuLayB/%EC%98%A8%EA%B8%B0%EB%A1%9D?node-id=0-1&p=f&t=MrHQne5S9sjzOato-0)
75+
&nbsp;&nbsp;&nbsp;[🌸 온기록 노션](https://arrow-battery-d95.notion.site/18a0464afcbc81dfa1cac08ba4e57ffa)
76+
77+
78+
******
79+
80+
## 📈 Flowchart
81+
![온기록 플로우차트](static/images/readme/onrecord_flowchart.png)
82+
<br>
83+
**온기록 서비스의 동작 흐름**
84+
> 1. 사용자가 **회원가입 후 로그인**
85+
> 2. 반려동물 또는 반려식물을 **등록**
86+
> 3. 캘린더에서 **날짜를 선택하여 일기 작성**
87+
> 4. AI가 **반려친구의 입장에서 자동으로 답장 생성**
88+
> 5. 사용자는 **AI 응답을 확인하고 감정 교류 가능**
89+
> 6. 작성한 일기를 공개여부를 통해 다른 사람들과 **공유 가능**
90+
> 7. 다른 사람들의 일기에 좋아요, 댓글로 **소통 가능**
91+
92+
## 🧱 System Architecture
93+
![온기록 시스템아키텍쳐](static/images/readme/onrecord_systemarchitecture.png)
94+
95+
## 📀 ERD
96+
![온기록 ERD](static/images/readme/onrecord_erd.png)
97+
98+
## 핵심 기능
99+
> 1. 캘린더 기반 일기 작성
100+
• 반려동물 및 반려식물을 대상으로 날짜별 일기 작성
101+
• 감정(이모지) 및 날씨 선택 기능
102+
• 다이어리 리스트 및 개별 일기 상세 보기 가능
103+
> 2. AI 답변 생성 기능
104+
• 사용자가 작성한 일기에 대해 AI가 반려친구(동물/식물)의 입장에서 답장을 생성
105+
• AI 응답을 통해 사용자와 반려친구 간의 인터랙션을 강화
106+
> 3. 반려친구 관리 기능
107+
• 반려동물 및 반려식물 등록 및 삭제 기능
108+
• 반려친구의 사진, 이름, 성격 등을 추가하여 맞춤형 관리 가능
109+
> 4. 공개/비공개 설정
110+
• 일기별로 전체 공개/비공개 설정이 가능하여 프라이버시 보호
111+
• 향후 커뮤니티 기능과 연계 가능
112+
113+
## 사용 예시
114+
#### 1. 회원가입 및 로그인
115+
<br>
116+
• 회원가입 후, 로그인하여 반려친구를 등록할 수 있는 초기 설정 페이지로 이동<br>
117+
<img src="/static/images/readme/first_page.png" width="50%">
118+
<br>
119+
120+
#### 2. 반려친구 등록
121+
<br>
122+
• 반려동물 또는 반려식물 추가
123+
<br>
124+
<img src="/static/images/readme/create_pet_or_plant.png" width="50%">
125+
<br>
126+
• 사진 업로드, 특징, 성격 설정 등의 기능을 통해 개별 맞춤 설정
127+
<br>
128+
<p align="center">
129+
<img src="/static/images/readme/create_pet.png" width="45%">
130+
<img src="/static/images/readme/create_plant.png" width="45%">
131+
</p>
132+
<br>
133+
134+
#### 3. 캘린더 화면에서 일기 작성
135+
<br>
136+
• 원하는 날짜를 선택 후, 반려친구를 지정하여 일기 작성<br>
137+
<img src="/static/images/readme/view_calendar.png" width="50%">
138+
<br>
139+
140+
#### 4. 일기 작성
141+
<br>
142+
• 감정 및 날씨 선택, 텍스트 입력 기능 제공<br>
143+
<img src="/static/images/readme/create_diaries.png" width="50%">
144+
<br>
145+
146+
#### 5. AI 답변 확인
147+
<br>
148+
• 작성한 일기에 대해 AI가 반려친구의 입장에서 답장을 자동 생성
149+
• 감정 분석을 기반으로 자연스러운 반응 제공<br>
150+
<img src="/static/images/readme/detail_diaries.png" width="50%">
151+
<br>
152+
153+
#### 6. 일기 리스트 및 상세보기
154+
<br>
155+
• 기록된 일기를 캘린더 혹은 리스트 뷰에서 확인<br>
156+
• 특정 일기 클릭 시, 상세 페이지로 이동하여 전체 내용 및 AI 답장 확인 가능
157+
<br>
158+
<img src="/static/images/readme/onrecord_list.png" width="50%">
159+
<br>
160+
161+
#### 7. 반려친구 관리 및 삭제 기능(마이페이지)
162+
<br>
163+
• 반려친구 추가/수정/삭제 가능
164+
<br>
165+
• 반려친구 데이터와 함께 기존의 작성된 일기들도 함께 삭제
166+
<br>
167+
<img src="/static/images/readme/mypage.png" width="50%">
168+
<br>
169+
170+
#### 8. 커뮤니티 기능(모두의 온기록)
171+
<br>
172+
<img src="/static/images/readme/community.png" width="50%">
173+
174+
## 🐶 팀원 소개
175+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[0HooHI](https://github.com/0HooHI "김영호 Github")
176+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[mangoooooo1](https://github.com/mangoooooo1 "박혜린 Github")
177+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[l-wanderer01](https://github.com/l-wanderer01 "장재훈 Github")
178+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[cestjeudi](https://github.com/cestjeudi "조주영 Github")
179+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Dosp74](https://github.com/Dosp74 "한종서 Github")
180+
181+
![온기록 팀 소개](static/images/readme/onrecord_team.png)
182+
<!--
183+
<details><summary>접고 펴는 기능
184+
</summary>
185+
186+
*Write here!*
187+
</details> -->

static/css/view_calendar.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -342,6 +342,11 @@ img {
342342
width: 14.28%;
343343
}
344344

345+
/* .dropdowns{
346+
position: relative;
347+
right: 1rem;
348+
} */
349+
345350
.calendar-container{
346351
position: relative;
347352
}

static/images/readme/community.png

318 KB
Loading
597 KB
Loading
204 KB
Loading
123 KB
Loading
172 KB
Loading
548 KB
Loading
129 KB
Loading

static/images/readme/gunicorn.png

12.8 KB
Loading

0 commit comments

Comments
 (0)