Skip to content

Commit 0669f3f

Browse files
authored
Create README.md
1 parent 0faa012 commit 0669f3f

File tree

1 file changed

+133
-0
lines changed

1 file changed

+133
-0
lines changed

README.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# 👋 ABOUT Doc'Tech
2+
3+
<div align="center">
4+
5+
![로고](https://github.com/user-attachments/assets/d4a9290a-5879-4797-8f0b-a6db2c98819c)
6+
7+
<img width="417" alt="image" src="https://github.com/user-attachments/assets/85b3d706-b2bd-446b-badc-9c99ca76f584">
8+
9+
기존 비대면 진료에서는 과도한 개인 진료 서류 제출, 신속한 처방의 어려움, 불필요한 개인정보 노출 등의 문제가 있었습니다. <br>
10+
이를 해결하기 위해 의료 마이데이터를 활용하여 환자가 자신의 건강 상태를 효율적으로 관리하고, <br>이를 바탕으로 비대면 진료 서비스에서 정확한 진단을 받을 수 있도록 지원합니다.
11+
12+
[🎬 Doc'tech 시연영상 🎬]()
13+
14+
</div>
15+
<br>
16+
17+
## 🔍 Main Features
18+
### 1️⃣ 의료 마이데이터 연동
19+
마이데이터 API 서버를 통해 내 의료 마이데이터(건강검진/예방접종/진료이력/투약이력)를 한 곳에서 모아볼 수 있습니다.
20+
21+
### 2️⃣ 비대면 진료
22+
언제 어디서나 쉽고 간편하게 예약하고 비대면 진료를 받을 수 있습니다.<br>
23+
이때, 비식별화된 마이데이터가 사용자 동의 하에 의사와 공유되어 보다 정확한 진료가 이루어집니다.
24+
25+
### 3️⃣ 빠른 지도 검색
26+
인근 병원 · 약국 · 응급실을 지도를 통해 빠르게 찾아볼 수 있습니다.
27+
28+
<br>
29+
30+
## 👥 Team Members
31+
<div align="center">
32+
33+
| [곽수찬](https://github.com/soooochan) | [김지윤](https://github.com/jyjyjy25) |
34+
|--------|------- |
35+
| <img height="200px" src= "https://github.com/user-attachments/assets/beac5c0a-c58c-4374-9a2c-35e29f3f5552"> | <img width="190px" src="https://github.com/user-attachments/assets/5bd214d5-ae98-4111-a9ac-4c8c4deb929b"> |
36+
| ✔️ 회원가입/로그인 <br> ✔️ 메일 인증 API <br> | ✔️ DB 설계 <br> ✔️ 기관(병원, 약국) 검색 API <br> ✔️ 비대면 진료 예약 API <br> ✔️ 마이데이터 연동 API <br> ✔️ 결제 API <br> ✔️ 보안키패드 구현 <br> ✔️ CI/CD 구축 <br>|
37+
</div>
38+
39+
## ⚒️ Stacks
40+
41+
| Skill | Name |
42+
|--------|------- |
43+
| Language | `JAVA 17` |
44+
| Framework | `Spring Boot 3.2.3` |
45+
| Dependencies | `Spring Validation`, `Spring Data JPA`, `Spring Security + JWT` |
46+
| Database | `Mysql 8.0`, `Redis 7.4`|
47+
| DevOps | `Docker`, `docker-compose`, `Github Actions` |
48+
49+
<br>
50+
51+
## 🏗️ Architecture
52+
![doc'tech-Architecture](https://github.com/user-attachments/assets/5c83dba1-466a-4146-ab97-10091a2656cb)
53+
54+
<br>
55+
56+
## 📍 ERD
57+
![doc'tech-ERD](https://github.com/user-attachments/assets/d44bd482-4fb8-4ca8-b95d-13f8f2985ee2)
58+
59+
<br>
60+
61+
## 📜 Covention
62+
### Code Convetion
63+
| 항목 | 규칙 |
64+
|---------------------|---------------------------------------------------------------------------------------|
65+
| `Class` | **PascalCase** |
66+
| `Function` | **camelCase** |
67+
| `Variable` | **camelCase** |
68+
| `DB Table` | **snake_case** |
69+
70+
### Git Convention
71+
### Prefix
72+
73+
| type | what |
74+
|--------------|-----------------------|
75+
| `Feat` | 기능 구현 |
76+
| `Fix` | 버그 수정 |
77+
| `Remove` | 파일, 코드, 기능 삭제 |
78+
| `Refactor` | 리팩토링 |
79+
| `Chore` | 패키지 구조 수정 |
80+
| `Docs` | 문서 수정 |
81+
| `Infra` | 인프라 관련 작업 |
82+
| `Hotfix` | 운영 서버 핫픽스 작업 |
83+
| `Setting` | 환경 설정 |
84+
85+
### Branch Naming
86+
`<Prefix>/#<Issue_Number>-<Description>`
87+
88+
### Commit Message
89+
`<Prefix>: <Description>`
90+
91+
<br>
92+
93+
## 🗂️ Package
94+
```
95+
├── 🗂️ .gitignore
96+
├── 🗂️ .gitmodules
97+
├── 🗂️ Dockerfile
98+
├── 🗂️ docker-compose.yml
99+
├── 🗂️ submodule-config
100+
└── 🗂️ src.main.java.dac2dac
101+
│   └── 🗂️ doctech
102+
│   ├── 💽 Application
103+
│   │   ├── 🗂️ agency
104+
│   │   │   ├── 📂 controller
105+
│   │   │   ├── 📂 dto
106+
│   │   │   │   ├── request
107+
│   │   │   │   └── response
108+
│   │   │   ├── 📂 entity
109+
│   │   │   ├── 📂 repository
110+
│   │   │   ├── 📂 service
111+
│   │   │   └── 📂 vo
112+
│   │   ├── 🗂️ bootpay
113+
│   │   ├── 🗂️ common
114+
│   │   │   ├── 📂 component
115+
│   │   │   ├── 📂 config
116+
│   │   │   ├── 📂 constant
117+
│   │   │   │   ├── ErrorCode
118+
│   │   │   │   └── SuccessCode
119+
│   │   │   ├── 📂 entity
120+
│   │   │   ├── 📂 error
121+
│   │   │   │   ├── 📂 exception
122+
│   │   │   │   └── RestExceptionHandler
123+
│   │   │   ├── 📂 response
124+
│   │   │   └── 📂 utils
125+
│   │   ├── 🗂️ doctor
126+
│   │   ├── 🗂️ health_list
127+
│   │   ├── 🗂️ keypad
128+
│   │   ├── 🗂️ mydata
129+
│   │   ├── 🗂️ noncontact_diag
130+
│   │   ├── 🗂️ user
131+
│   │   └── 🗂️ external
132+
```
133+
<br><br>

0 commit comments

Comments
 (0)