Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

๐Ÿ“‘ Readme v0.0.2 #26

Merged
merged 3 commits into from
Mar 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 30 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
## ๐Ÿ’ฐ Pennyway

> ์ง€์ถœ ๊ด€๋ฆฌ SNS ํ”Œ๋žซํผ

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

<br/>

Expand Down Expand Up @@ -38,7 +40,9 @@
<br/>

## ๐ŸŒณ Branch Convention

> ๐Ÿ’ก Git-Flow ์ „๋žต์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.

- main
- ๋ฐฐํฌ ๊ฐ€๋Šฅํ•œ ์ƒํƒœ์˜ ์ฝ”๋“œ๋งŒ์„ ๊ด€๋ฆฌํ•˜๋Š” ํ”„๋กœ๋•์…˜์šฉ ๋ธŒ๋žœ์น˜
- PM(์–‘์žฌ์„œ)์˜ ์Šน์ธ ํ›„ ๋ณ‘ํ•ฉ ๊ฐ€๋Šฅ
Expand All @@ -55,7 +59,9 @@
<br/>

## ๐Ÿค Commit Convention

> ๐Ÿ’ก angular commit convention

- feat: ์‹ ๊ทœ ๊ธฐ๋Šฅ ์ถ”๊ฐ€
- fix: ๋ฒ„๊ทธ ์ˆ˜์ •
- docs: ๋ฌธ์„œ ์ˆ˜์ •
Expand All @@ -68,6 +74,7 @@
<br/>

## ๐Ÿ“Œ Architecture

### 1๏ธโƒฃ System Architecture

<div align="center">
Expand All @@ -89,35 +96,45 @@
### 4๏ธโƒฃ ERD

<div align="center">
<img src="" width="600">
<img src="https://github.com/CollaBu/pennyway-was/assets/96044622/f053b24e-cc1b-4f71-9da6-669f03a98d58" width="650">
</div>

<br/>

## ๐Ÿ“— Tech Stack

### 1๏ธโƒฃ Framework & Library

- JDK 17
- SpringBoot 3.2.3
- SpringBoot Security 6.2.2
- Spring Boot Starter Security 3.2.4
- Spring Data JPA 3.2.3
- Spring Doc Open API 2.3.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/)
- jjwt 0.11.5
- jjwt 0.12.5
- httpclient5 5.2.25.RELEASE
- OpenFeign 4.0.6

### 2๏ธโƒฃ Infrastructure Architecture
### 2๏ธโƒฃ Build Tools

- Gradle 7.6.4

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

- MySQL 8
- Redis 7.0
- Redis 7.2.4

### 4๏ธโƒฃ ERD
- AWS EC2 (for Build Server)
- AWS GW
### 4๏ธโƒฃ Infra

- AWS EC2 (for Build Server, Bastion Server)
- AWS NAT Gateway
- AWS S3
- AWS Route53
- AWS VPC
- AWS Elastic Load Balancer
- AWS SNS
- Docker & Docker-compose
- Ngnix
- GitHub Actions
Loading