Skip to content

Commit

Permalink
docs: ๐Ÿ“ Readme-v0.0.3 (#108)
Browse files Browse the repository at this point in the history
* fix: ๋ฐฐํฌ ํŒŒ์ดํ”„๋ผ์ธ ์ด๋ฏธ์ง€ ๋นŒ๋“œ ๋ฒ„์ „ ์ถ”๊ฐ€

* docs: root readme ์ˆ˜์ •

* docs: external-api ๋ชจ๋“ˆ docs ์ˆ˜์ •
  • Loading branch information
psychology50 authored Jun 5, 2024
1 parent 7210b0f commit 00ac66b
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 15 deletions.
35 changes: 20 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

> ์ง€์ถœ ๊ด€๋ฆฌ SNS ํ”Œ๋žซํผ
| Version # | Revision Date | Description | Author |
|:---------:|:-------------:|:------------------------------|:------:|
| v0.0.1 | 2024.03.07 | ํ”„๋กœ์ ํŠธ ๊ธฐ๋ณธ ์„ค๋ช… ์ž‘์„ฑ | ์–‘์žฌ์„œ |
| v0.0.2 | 2024.03.29 | ERD ์ถ”๊ฐ€, ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ๋ฒ„์ „ ์ˆ˜์ •, Infra ์ถ”๊ฐ€ | ์–‘์žฌ์„œ |
| Version # | Revision Date | Description | Author |
|:---------:|:-------------:|:-------------------------------------|:------:|
| v0.0.1 | 2024.03.07 | ํ”„๋กœ์ ํŠธ ๊ธฐ๋ณธ ์„ค๋ช… ์ž‘์„ฑ | ์–‘์žฌ์„œ |
| v0.0.2 | 2024.03.29 | ERD ์ถ”๊ฐ€, ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ๋ฒ„์ „ ์ˆ˜์ •, Infra ์ถ”๊ฐ€ | ์–‘์žฌ์„œ |
| v0.0.3 | 2024.04.05 | ERD ์ˆ˜์ •, ๊ธฐ์ˆ  ์Šคํƒ ์ถ”๊ฐ€, Infra ๋ฐ ์•„ํ‚คํ…์ฒ˜ ์ถ”๊ฐ€/์ˆ˜์ • | ์–‘์žฌ์„œ |

<br/>

Expand Down Expand Up @@ -62,14 +63,15 @@

> ๐Ÿ’ก angular commit convention
- feat: ์‹ ๊ทœ ๊ธฐ๋Šฅ ์ถ”๊ฐ€
- fix: ๋ฒ„๊ทธ ์ˆ˜์ •
- docs: ๋ฌธ์„œ ์ˆ˜์ •
- rename: ์ฃผ์„, ๋กœ๊ทธ, ๋ณ€์ˆ˜๋ช… ๋“ฑ ์ˆ˜์ •
- style: ์ฝ”๋“œ ํฌ๋งทํŒ…, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ (์ฝ”๋“œ ๋ณ€๊ฒฝ ์—†๋Š” ๊ฒฝ์šฐ)
- refactor: ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
- test: ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŽ™ํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€
- chore: ๋นŒ๋“œ ์—…๋ฌด ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •
- release: ๋ฐฐํฌ ๋ฒ„์ „ ์—…๋ฐ์ดํŠธ (major)
- feat: ์‹ ๊ทœ ๊ธฐ๋Šฅ ์ถ”๊ฐ€ (minor)
- refactor: ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง (minor)
- fix: ๋ฒ„๊ทธ ์ˆ˜์ • (patch)
- docs: ๋ฌธ์„œ ์ˆ˜์ • (patch)
- rename: ์ฃผ์„, ๋กœ๊ทธ, ๋ณ€์ˆ˜๋ช… ๋“ฑ ์ˆ˜์ • (patch)
- style: ์ฝ”๋“œ ํฌ๋งทํŒ…, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ (์ฝ”๋“œ ๋ณ€๊ฒฝ ์—†๋Š” ๊ฒฝ์šฐ) (patch)
- test: ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŽ™ํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€ (patch)
- chore: ๋นŒ๋“œ ์—…๋ฌด ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ • (patch)

<br/>

Expand All @@ -84,19 +86,19 @@
### 2๏ธโƒฃ Infrastructure Architecture

<div align="center">
<img src="https://github.com/KCY-Fit-a-Pet/fit-a-pet-server/assets/96044622/f7cf3405-c112-4531-b313-9e3fcb10f673" width="600">
<img src="https://github.com/CollaBu/pennyway-was/assets/96044622/388d9e1f-14af-4dda-8c6f-a2e1572f412f" width="600">
</div>

### 3๏ธโƒฃ Multi Module Architecture

<div align="center">
<img src="https://github.com/KCY-Fit-a-Pet/fit-a-pet-server/assets/96044622/b6a47354-f314-4d09-ba17-116fe86b64cf" width="600">
<img src="https://github.com/CollaBu/pennyway-was/assets/96044622/d5e6ac96-5398-44e9-bea9-6b95d12897cb" width="600">
</div>

### 4๏ธโƒฃ ERD

<div align="center">
<img src="https://github.com/CollaBu/pennyway-was/assets/96044622/f053b24e-cc1b-4f71-9da6-669f03a98d58" width="650">
<img src="https://github.com/CollaBu/pennyway-was/assets/96044622/a7ba3a0e-bf6b-45c7-9284-1f2053a4c27a" width="650">
</div>

<br/>
Expand All @@ -109,10 +111,13 @@
- SpringBoot 3.2.3
- Spring Boot Starter Security 3.2.4
- Spring Data JPA 3.2.3
- Spring Data Redis
- Spring Boot Redisson 3.30.0
- QueryDsl 5.0.0
- Spring Doc Open API 2.4.0
- Lombok 1.18.30
- [JUnit 5](https://junit.org/junit5/docs/current/user-guide/)
- testcontainers 1.19.7
- jjwt 0.12.5
- httpclient5 5.2.25.RELEASE
- OpenFeign 4.0.6
Expand Down
8 changes: 8 additions & 0 deletions pennyway-app-external-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@
- ์›น ๋ฐ security ๊ด€๋ จ ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ์˜์กด์„ฑ์„ ๊ฐ–๋Š”๋‹ค.
- Presentation Layer์— ํ•ด๋‹นํ•˜๋Š” Controller์™€ ํ•ต์‹ฌ ๋น„์ฆˆ๋‹ˆ์Šค ๋กœ์ง์„ ์ฒ˜๋ฆฌํ•˜๋Š” Usecase๋ฅผ ํฌํ•จํ•œ๋‹ค.

### ๐Ÿ“Œ Architecture

<div align="center">
<img src="https://github.com/CollaBu/pennyway-was/assets/96044622/932db02d-7c08-4052-82d5-014148f035a0" width="600">
</div>

- Facade ํŒจํ„ด์„ ์‚ฌ์šฉํ•˜์—ฌ Controller์™€ Service ๊ณ„์ธต์„ ๋ถ„๋ฆฌํ•˜์—ฌ ๋‹จ์œ„ ํ…Œ์ŠคํŠธ๋ฅผ ์šฉ์ดํ•˜๊ฒŒ ํ•œ๋‹ค.

### ๐Ÿท๏ธ Directory Structure

```agsl
Expand Down

0 comments on commit 00ac66b

Please sign in to comment.