Skip to content

Commit

Permalink
docs: 프로젝트 소개 추가 (#66)
Browse files Browse the repository at this point in the history
  • Loading branch information
junseoplee committed Oct 28, 2024
1 parent f4eaaf3 commit 754312f
Showing 1 changed file with 55 additions and 21 deletions.
76 changes: 55 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
| 김용빈 | 이준섭 |
|:--------------------------------------------------------------------------:|:---------------------------------------------------------------------------:|
| <img width="160px" src="https://avatars.githubusercontent.com/yongbin97"/> | <img width="160px" src="https://avatars.githubusercontent.com/junseoplee"/> |
| [yongbin97](https://github.com/yongbin97) | [junseoplee](https://github.com/junseoplee) |
| **[post / tag / memo]** 도메인 개발 | **[auth / user / archive]** <br/> 도메인 개발, 소셜 로그인 및 인프라 구축 |
## 🛠️ 기술 스택

- 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 &rarr; Develop &rarr; Main]
- Github Actions
<br>

- 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
<br>

- Swagger
## 🏗️ Architecture

<img width="1583" alt="someup_architecture" src="https://github.com/user-attachments/assets/525130f8-931e-4782-959a-dcae571741f3">

<br>

## 📐 ERD

![someup](https://github.com/user-attachments/assets/85b80a48-c900-45be-a4bd-b95e5e3d7785)

<br>

0 comments on commit 754312f

Please sign in to comment.