Skip to content

Commit 2b07471

Browse files
authored
README.md 설명 추가 (#90)
* docs: README.md 설명 추가 - 프로젝트 소개 추가 - 서비스 기능 설명 추가 - 기술 스택 추가 - 아키텍처 다이어그램 추가 * docs: README 문서 이미지 및 뱃지 수정 - 이미지 너비 100% 설정 - 기술 스택 뱃지 줄바꿈 추가 * docs: README 뱃지 색상 수정 - Loki, Tempo 뱃지 색상 변경
1 parent 936d8cb commit 2b07471

1 file changed

Lines changed: 75 additions & 2 deletions

File tree

README.md

Lines changed: 75 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,75 @@
1-
# recycle-study
2-
주기적 복습 도우미
1+
<div align="center">
2+
<img alt="recycle-study-logo" src="https://github.com/user-attachments/assets/f0f510c6-6d8d-4d40-97af-31dc1616c664" />
3+
</div>
4+
5+
## 서비스 소개
6+
7+
> 웹에서 발견한 지식, 클릭 한 번으로 저장하고 이메일로 복습받으세요.
8+
9+
RecycleStudy는 에빙하우스 망각 곡선 기반의 복습 알림 서비스입니다.
10+
Chrome Extension으로 현재 보고 있는 웹 페이지를 1클릭으로 저장하면,
11+
설정한 복습 주기에 맞춰 이메일로 링크를 다시 전달해드립니다.
12+
13+
👉 [Chrome Web Store에서 설치하기](https://chromewebstore.google.com/detail/recycle-study/hlbbjgnpalplnmpncbjlfpedbgakbgjk)
14+
15+
---
16+
17+
## 기능 소개
18+
19+
### 1. 이메일 인증 기반 로그인
20+
21+
별도 회원가입 없이 이메일 입력과 인증 링크 클릭만으로 시작할 수 있어요.
22+
23+
| | |
24+
|---|---|
25+
| <img width="100%" alt="로그인" src="https://github.com/user-attachments/assets/40259474-84eb-4f34-b3e0-b35b6a67c244" /> | <img width="100%" alt="이메일 인증" src="https://github.com/user-attachments/assets/157c8066-6734-4573-aa6b-b16b72fe7e12" /> |
26+
27+
### 2. 커스텀 복습 주기 등록
28+
29+
기본 에빙하우스 주기 외에도 나만의 주기를 최대 5개까지 설정할 수 있어요. (최소 10분 ~ 최대 1년)
30+
31+
| | |
32+
|---|---|
33+
| <img width="100%" alt="복습 주기 추가" src="https://github.com/user-attachments/assets/ea80014c-207c-4083-a2d5-227e94860ca4" /> | <img width="100%" alt="복습 주기 조회" src="https://github.com/user-attachments/assets/1611b765-898b-4df7-a428-7421e2b3885f" /> |
34+
35+
### 3. URL 저장 & 주기별 알림
36+
37+
익스텐션 클릭 한 번으로 현재 페이지 URL을 저장하고, 선택한 주기에 맞춰 이메일 알림을 받아요.
38+
39+
| | |
40+
|---|---|
41+
| <img width="100%" alt="URL 저장" src="https://github.com/user-attachments/assets/508da208-ddcc-4f24-afb3-683cd9c4f647" /> | <img width="100%" alt="저장 완료 화면" src="https://github.com/user-attachments/assets/ebad2044-2263-4623-8a77-7a4cdb19a7e6" /> |
42+
43+
### 4. 알림 시간 설정
44+
45+
이메일을 받고 싶은 시간대를 직접 설정할 수 있어요.
46+
47+
| | |
48+
|---|---|
49+
| <img width="100%" alt="알림 시간 설정 조회" src="https://github.com/user-attachments/assets/f4d1b023-fda5-4f9a-aa5c-8116102fd756" /> | <img width="100%" alt="알림 시간 설정" src="https://github.com/user-attachments/assets/3d26cab8-e1f4-424a-938d-7f1f8f414eda" /> |
50+
51+
---
52+
53+
## 기술 스택
54+
55+
### Frontend (Chrome Extension)
56+
57+
<img src="https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black"><img src="https://img.shields.io/badge/Vite-646CFF?style=for-the-badge&logo=vite&logoColor=white"><img src="https://img.shields.io/badge/Chrome_Extension-4285F4?style=for-the-badge&logo=googlechrome&logoColor=white">
58+
59+
### Backend
60+
61+
<img src="https://img.shields.io/badge/Java-007396?style=for-the-badge&logo=openjdk&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/JPA-6DB33F?style=for-the-badge&logo=hibernate&logoColor=white"><img src="https://img.shields.io/badge/MySQL-4479A1?style=for-the-badge&logo=mysql&logoColor=white">
62+
<br>
63+
<img src="https://img.shields.io/badge/Flyway-CC0200?style=for-the-badge&logo=flyway&logoColor=white"><img src="https://img.shields.io/badge/AWS_SES-232F3E?style=for-the-badge&logo=amazonaws&logoColor=white"><img src="https://img.shields.io/badge/Thymeleaf-005F0F?style=for-the-badge&logo=thymeleaf&logoColor=white">
64+
65+
### Infra
66+
67+
<img src="https://img.shields.io/badge/AWS_EC2-FF9900?style=for-the-badge&logo=amazonaws&logoColor=white"><img src="https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white"><img src="https://img.shields.io/badge/Nginx-009639?style=for-the-badge&logo=nginx&logoColor=white"><img src="https://img.shields.io/badge/GitHub_Actions-2088FF?style=for-the-badge&logo=githubactions&logoColor=white">
68+
<br>
69+
<img src="https://img.shields.io/badge/Prometheus-E6522C?style=for-the-badge&logo=prometheus&logoColor=white"><img src="https://img.shields.io/badge/Grafana-F46800?style=for-the-badge&logo=grafana&logoColor=white"><img src="https://img.shields.io/badge/Loki-F5A800?style=for-the-badge&logo=grafana&logoColor=white"><img src="https://img.shields.io/badge/Tempo-7B5EA7?style=for-the-badge&logo=grafana&logoColor=white">
70+
71+
---
72+
73+
## 아키텍처 설계
74+
75+
<img width="100%" alt="recycle-study-aws-diagram" src="https://github.com/user-attachments/assets/94d8847a-71c3-473e-8b42-0de74a56128b" />

0 commit comments

Comments
 (0)