Skip to content

Commit

Permalink
📑 Readme v0.0.2 (#26)
Browse files Browse the repository at this point in the history
* docs: erd 추가

* docs: 라이브러리 버전 수정

* docs: version 관리 설명 추가
  • Loading branch information
psychology50 authored Mar 29, 2024
1 parent 4b7a313 commit 6334e72
Showing 1 changed file with 30 additions and 13 deletions.
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

0 comments on commit 6334e72

Please sign in to comment.