Skip to content

Commit

Permalink
readme 사진 및 설명 추가 (#94)
Browse files Browse the repository at this point in the history
  • Loading branch information
kih00 authored Feb 2, 2025
1 parent 8031c9e commit 0cfd61b
Show file tree
Hide file tree
Showing 5 changed files with 79 additions and 50 deletions.
129 changes: 79 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,47 +6,48 @@

### Memo with tags Server

[<img src="https://img.shields.io/badge/-readme.md-important?style=flat&logo=google-chrome&logoColor=white" />]() [<img src="https://img.shields.io/badge/-tech blog-blue?style=flat&logo=google-chrome&logoColor=white" />]() [<img src="https://img.shields.io/badge/release-v0.0.0-yellow?style=flat&logo=google-chrome&logoColor=white" />]()
<br/> [<img src="https://img.shields.io/badge/프로젝트 기간-2024.12.23~2025.02.02-green?style=flat&logo=&logoColor=white" />]()
[<img src="https://img.shields.io/badge/프로젝트 기간-2024.12.23~2025.02.02-green?style=flat&logo=&logoColor=white" />]()

</div>

## 📝MemoWithTags
# MemoWithTags

**MemoWithTags**는 기존의 디렉터리 기반 메모 관리 방식을 탈피하여, **태그 기반의 유연한 메모 관리****AI 기반 태그 추천** 기능을 통해 사용자가 더욱 효율적으로 정보를 분류하고 검색할 수 있도록 도와주는 혁신적인 메모 앱입니다.
# 📝 MemoWithTags

---
# About our Project

**MemoWithTags**는 기존의 디렉터리 기반 메모 관리 방식을 탈피하여, **태그 기반의 유연한 메모 관리****AI 기반 태그 추천** 기능을 통해 사용자가 더욱 효율적으로 정보를 분류하고 검색할 수 있도록 도와주는 혁신적인 메모 앱입니다.

## 주요 특징
## 주요 특징

**태그 기반 메모 관리**
- **태그 기반 메모 관리**
기존의 폴더나 디렉터리 방식과 달리, 메모마다 자유롭게 태그를 부여할 수 있어 다양한 관점에서 메모를 분류하고 검색할 수 있습니다.

**AI 자동 태그 추천**

- **AI 자동 태그 추천**
메모 작성 시 AI가 핵심 내용을 분석하여 적절한 태그를 자동으로 추천해줍니다. 덕분에 사용자는 더욱 빠르게 메모를 정리하고, 중요한 정보를 놓치지 않을 수 있습니다.

**직관적 인터페이스**

- **직관적 인터페이스**
사용자 경험을 극대화한 디자인과 간편한 인터페이스를 제공하여 복잡한 분류 체계 없이도 원하는 메모를 즉시 찾을 수 있습니다.

**효율적인 검색 기능**

- **효율적인 검색 기능**
태그 기반 검색과 키워드 필터링 기능을 통해 수많은 메모 속에서도 원하는 정보를 빠르게 조회할 수 있습니다.

**맞춤형 워크플로우 지원**

- **맞춤형 워크플로우 지원**
개인의 업무 스타일에 맞게 태그를 커스터마이징하고, 메모를 자유롭게 연결할 수 있어 창의적인 아이디어 정리에 최적화되어 있습니다.


<br />

### 화면 구성
|Screen #1|Screen #2|
|:---:|:---:|
|<img src="https://user-images.githubusercontent.com/80824750/208456048-acbf44a8-cd71-4132-b35a-500047adbe1c.gif" width="400"/>|<img src="https://user-images.githubusercontent.com/80824750/208456234-fb5fe434-aa65-4d7a-b955-89098d5bbe0b.gif" width="400"/>|


<br />
## 📱 화면 구성
<img src="./readme_images/wireframe_1.png" alt="회원가입 및 비밀번호 찾기"></td>
<img src="./readme_images/wireframe_3.png" alt="로그인 및 메인 기능"></td>
<img src="./readme_images/wireframe_2.png" alt="검색 및 사용자 페이지"></td>

# 우리 조의 강점
---
# 💪 우리 조의 강점

### 🚀 기획부터 완성까지
치밀한 기획을 바탕으로 실제 서비스로 이용 가능할 정도의 높은 완성도의 앱을 개발하였습니다..
Expand All @@ -57,7 +58,7 @@
### 🗂 효율적인 디렉터리 구조
체계적인 디렉터리 설계를 통해, 향후 서비스 확장 시 **유지 보수 및 확장성이 뛰어나도록** 준비했습니다.


---
# 📌 주요 기능

MemoWithTags는 태그 기반 메모 관리와 AI 자동 태그 추천을 통해 효율적인 메모 정리를 지원하는 서비스입니다.
Expand Down Expand Up @@ -112,52 +113,80 @@ MemoWithTags는 태그 기반 메모 관리와 AI 자동 태그 추천을 통해
이 API 목록을 통해 MemoWithTags의 주요 기능을 한눈에 확인할 수 있습니다.
더욱 직관적인 태그 기반 메모 관리와 AI 자동 태그 추천 기능을 통해 생산성을 높여보세요! 🚀



👉🏻 [API 바로보기](http://43.201.64.202:8080/swagger-ui/index.html#)


<br />
# 🧑‍💻 Development

## ⚙ 기술 스택
### Back-end
<div>
<img src="https://img.shields.io/badge/Kotlin-7F52FF?style=for-the-badge&logo=kotlin&logoColor=white">
<img src="https://img.shields.io/badge/Spring-6DB33F?style=for-the-badge&logo=spring&logoColor=white"/>
<img src="https://img.shields.io/badge/Spring_Boot-6DB33F?style=for-the-badge&logo=springboot&logoColor=white"/>
<img src="https://img.shields.io/badge/Spring_Security-6DB33F?style=for-the-badge&logo=springboot&logoColor=white"/>
<img src="https://img.shields.io/badge/Spring_Boot-6DB33F?style=for-the-badge&logo=SpringBoot&logoColor=white"/>
<img src="https://img.shields.io/badge/Spring_Security-6DB33F?style=for-the-badge&logo=SpringSecurity&logoColor=white"/>
<img src="https://img.shields.io/badge/Json_Web_Tokens-000000?style=for-the-badge&logo=JsonWebTokens&logoColor=white"/>
<img src="https://img.shields.io/badge/Gradle-02303A?style=for-the-badge&logo=Gradle&logoColor=white"/>
<img src="https://img.shields.io/badge/MySQL-4479A1?style=for-the-badge&logo=mysql&logoColor=white"/>
<img src="https://img.shields.io/badge/Amazon_EC2-FF9900?style=for-the-badge&logo=AmazonEc2&logoColor=white"/>
<img src="https://img.shields.io/badge/Amazon_Rds-527FFF?style=for-the-badge&logo=AmazonRds&logoColor=white"/>
<img src="https://img.shields.io/badge/Swagger-85EA2D?style=for-the-badge&logo=Swagger&logoColor=black"/>
</div>

### Infra
### AI
<div>
<img src="https://img.shields.io/badge/Amazon_EC2-FF9900?style=for-the-badge&logo=amazonec2&logoColor=white"/>
<img src="https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=Python&logoColor=white"/>
<img src="https://img.shields.io/badge/Hugging_Face-FFD21E?style=for-the-badge&logo=HuggingFace&logoColor=black"/>
</div>

### Tools
<div>
<img src="https://img.shields.io/badge/Spring_Security-6DB33F?style=for-the-badge&logo=springboot&logoColor=white"/>
<img src="https://img.shields.io/badge/MySQL-4479A1?style=for-the-badge&logo=mysql&logoColor=white"/>
<img src="https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=Slack&logoColor=white"/>
<img src="https://img.shields.io/badge/Notion-000000?style=for-the-badge&logo=Notion&logoColor=white"/>
</div>

<br />

## 🛠️ 프로젝트 아키텍쳐
![no-image](https://user-images.githubusercontent.com/80824750/208294567-738dd273-e137-4bbf-8307-aff64258fe03.png)



<br />
## 🛢️ ERD
<img src="./readme_images/memo-with-tags_erd.png"/>

## 🤔 기술적 이슈와 해결 과정
- 소셜로그인


<br />

### 개발 로드맵
-
### 💁‍♂️ 프로젝트 팀원
| AI 개발 | User 개발 | Memo & Tag 개발 |
|:-------------------------------------------------:|:------------------------------------------:|:---------------------------------------------:|
| ![](https://github.com/Criminal0627.png?size=120) | ![](https://github.com/kih00.png?size=120) | ![](https://github.com/Leafguyk.png?size=120) |
| [김용범](https://github.com/Criminal0627) | [김인호](https://github.com/kih00) | [이종호](https://github.com/Leafguyk) |
- 메일 인증 시스템
- STMP 서버를 통해 이메일 인증 기능을 구현하는 과정에서 암호화 프로토콜(SSL/TLS), 구글 보안 정책 등으로 인해 여러 어려움을 겪었습니다.
- 아래의 웹 사이트를 참고하여 문제를 해결하였습니다.
- https://dev-annals.tistory.com/68
- https://docs.spring.io/spring-framework/reference/integration/email.html
- https://chatgpt.com/
- 소셜 로그인
- 카카오, 네이버, 구글 세 가지 서비스를 통해 로그인할 수 있도록 각각의 서비스에서 제공하는 API를 활용하였습니다.
- Java의 라이브러리를 Kotlin에서 사용하며 발생한 오류와, API 요청과 응답으로 쓰이는 JSON 파싱 중 발생한 오류 등을 해결하기 위해, ChatGPT와 Perplexity를 사용하였습니다.
- 내용이 긴 매모
- 내용이 긴 메모를 보낼 때, MySQL에서 정해진 content 필드의 크기 한계로 인해 오류가 발생하여 500 에러가 발생하였습니다.
- JPA Entity를 정의할 때 @Lob, @Column의 columnDefinition 지정 등으로 content 필드를 TEXT 타입으로 지정하여 해결하였습니다.


# 💁‍♂️ 프로젝트 팀원
<table style="width:100%; table-layout: fixed; text-align: center;">
<tr>
<th>iOS + PM</th>
<th>iOS</th>
<th>Design</th>
<th>Backend</th>
<th>Backend</th>
<th>Backend</th>
</tr>
<tr>
<td><img src="https://github.com/Swimming-in-Seoul.png" style="width:200px;" alt=""/></td>
<td><img src="https://github.com/jinmo0320.png" style="width:200px;" alt=""/></td>
<td><img src="https://ca.slack-edge.com/T07J9TH6PFE-U07J5165Z38-g7b812af4e69-512" style="width:200px;" alt=""/></td>
<td><img src="https://github.com/Criminal0627.png" style="width:200px;" alt=""/></td>
<td><img src="https://github.com/kih00.png" style="width:200px;" alt=""/></td>
<td><img src="https://github.com/Leafguyk.png" style="width:200px;" alt=""/></td>
</tr>
<tr>
<td><a href="https://github.com/Swimming-in-Seoul">류수영</a></td>
<td><a href="https://github.com/jinmo0320">최진모</a></td>
<td>한수정</td>
<td><a href="https://github.com/Criminal0627">김용범</a></td>
<td><a href="https://github.com/kih00">김인호</a></td>
<td><a href="https://github.com/Leafguyk">이종호</a></td>
</tr>
</table>
Binary file added readme_images/memo-with-tags_erd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme_images/wireframe_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme_images/wireframe_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme_images/wireframe_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0cfd61b

Please sign in to comment.