From f4eaaf3418f725d8ddfc061e0cae0edf5ace000c Mon Sep 17 00:00:00 2001 From: junseoplee Date: Mon, 14 Oct 2024 14:20:48 +0900 Subject: [PATCH 1/2] =?UTF-8?q?docs:=20=EC=8B=9C=EC=8A=A4=ED=85=9C=20?= =?UTF-8?q?=EA=B5=AC=EC=84=B1=EB=8F=84,=20=EA=B8=B0=EC=88=A0=20=EC=8A=A4?= =?UTF-8?q?=ED=83=9D=20=EC=A0=95=EB=A6=AC=20(#66)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d5698b2 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +## 시스템 구성도 +![image](https://github.com/user-attachments/assets/a487a4ce-80fc-4393-bac4-58aa42032b64) + +## 기술 스택 + +### Backend + +- Java (JDK 17) + +- Spring Boot 3.3.3 + +- Spring Data JPA + +- Spring Security (JWT, OAuth 2.0) + +- Spring AI, Vertex AI + +### Database + +- MySQL + +- Redis + +- AWS RDS + +### DevOps + +- Docker + +- AWS EC2, S3 + +- Github Actions + +- Jenkins, ArgoCD (향후 CI/CD 계획) + +- Nginx + +### API Documentation + +- Swagger From 754312fbe2a2c4aef9977e53013f7fc5bff192cb Mon Sep 17 00:00:00 2001 From: junseoplee Date: Tue, 29 Oct 2024 00:27:53 +0900 Subject: [PATCH 2/2] =?UTF-8?q?docs:=20=ED=94=84=EB=A1=9C=EC=A0=9D?= =?UTF-8?q?=ED=8A=B8=20=EC=86=8C=EA=B0=9C=20=EC=B6=94=EA=B0=80=20(#66)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 76 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 55 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index d5698b2..122b1f5 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,74 @@ -## 시스템 구성도 -![image](https://github.com/user-attachments/assets/a487a4ce-80fc-4393-bac4-58aa42032b64) +[![someup](https://github.com/user-attachments/assets/aa5243bc-e992-40b5-b83a-264d94581f44)](https://www.someup.site/) -## 기술 스택 +## 📘 프로젝트 인원 / 기간 -### Backend +- **개발 인원**: [기획 1명 / 디자인 1명 / FE 2명 / BE 2명] +- **개발 기간**: [2024.09 ~ 2024.10] -- Java (JDK 17) +### 🖥️ 백엔드 역할 -- Spring Boot 3.3.3 +| 김용빈 | 이준섭 | +|:--------------------------------------------------------------------------:|:---------------------------------------------------------------------------:| +| | | +| [yongbin97](https://github.com/yongbin97) | [junseoplee](https://github.com/junseoplee) | +| **[post / tag / memo]** 도메인 개발 | **[auth / user / archive]**
도메인 개발, 소셜 로그인 및 인프라 구축 | +## 🛠️ 기술 스택 -- Spring Data JPA +### 📦 Language & Framework -- Spring Security (JWT, OAuth 2.0) +![Java](https://img.shields.io/badge/java-007396?style=for-the-badge&logo=openjdk&logoColor=white) +![JUnit5](https://img.shields.io/badge/junit5-25A162?style=for-the-badge&logo=JUnit5&logoColor=white) +![Mockito](https://img.shields.io/badge/mockito-25A162?style=for-the-badge&logo=&logoColor=white) +![Spring_Boot](https://img.shields.io/badge/spring_boot-6DB33F?style=for-the-badge&logo=springboot&logoColor=white) +![Spring_Data_JPA](https://img.shields.io/badge/spring_data_jpa-6DB33F?style=for-the-badge&logo=spring&logoColor=white) -- Spring AI, Vertex AI +![Spring_security](https://img.shields.io/badge/spring_security-6DB33F?style=for-the-badge&logo=springsecurity&logoColor=white) +![JWT](https://img.shields.io/badge/jwt-000000?style=for-the-badge&logo=JSON%20web%20tokens&logoColor=white) +![OAuth2.0](https://img.shields.io/badge/oauth2.0-000000?style=for-the-badge&logo=oauth&logoColor=white) -### Database +![Spring_AI](https://img.shields.io/badge/spring_ai-6DB33F?style=for-the-badge&logo=spring&logoColor=white) +![Swagger](https://img.shields.io/badge/swagger-85EA2D?style=for-the-badge&logo=swagger&logoColor=black) -- MySQL +### 🛢️ Database -- Redis +![MySQL](https://img.shields.io/badge/mysql-4479A1?style=for-the-badge&logo=MySQL&logoColor=white) +![Redis](https://img.shields.io/badge/redis-DC382D?style=for-the-badge&logo=Redis&logoColor=white) -- AWS RDS +### ☁️ Infra -### DevOps +![AWS_EC2](https://img.shields.io/badge/aws_ec2-FF9900.svg?style=for-the-badge&logo=amazonec2&logoColor=white) +![AWS_RDS](https://img.shields.io/badge/aws_rds-527FFF.svg?style=for-the-badge&logo=amazonrds&logoColor=white) +![AWS_S3](https://img.shields.io/badge/aws_s3-569A31.svg?style=for-the-badge&logo=amazons3&logoColor=white) +![GitHub_Actions](https://img.shields.io/badge/github_actions-2088FF.svg?style=for-the-badge&logo=githubactions&logoColor=white) +![Docker](https://img.shields.io/badge/docker-2496ED.svg?style=for-the-badge&logo=docker&logoColor=white) +![Nginx](https://img.shields.io/badge/nginx-009639?style=for-the-badge&logo=nginx&logoColor=white) -- Docker +### 🌱 프로젝트 환경 -- AWS EC2, S3 +> - Java 17 +> - Spring Boot 3.3.3 +> - Gradle 8.8 +> - Git Flow [Feature → Develop → Main] -- Github Actions +
-- Jenkins, ArgoCD (향후 CI/CD 계획) +## ⚡ 협업 과정 - PR 및 코드 리뷰 -- Nginx +- [아카이브 API 구현 ](https://github.com/Someup/backend/pull/42) +- [게시글 관련 API 고도화](https://github.com/Someup/backend/pull/31) +- [로그아웃 구현](https://github.com/Someup/backend/pull/23) +- [게시글 조회, 저장, 수정 API](https://github.com/Someup/backend/pull/17) -### API Documentation +
-- Swagger +## 🏗️ Architecture + +someup_architecture + +
+ +## 📐 ERD + +![someup](https://github.com/user-attachments/assets/85b80a48-c900-45be-a4bd-b95e5e3d7785) + +