From 417a9374e4d928942b53c8d40f03eed71eb1ef7e Mon Sep 17 00:00:00 2001 From: dyk <73778096+dyk-im@users.noreply.github.com> Date: Mon, 17 Mar 2025 19:18:10 +0900 Subject: [PATCH] =?UTF-8?q?[Documentation]=20README.md=20=EC=B5=9C?= =?UTF-8?q?=EC=A2=85=EB=B3=B8=20=EC=99=84=EC=84=B1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 264 ++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 209 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 87ad14c..64b8e30 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,215 @@ -
+# Wedit -# Wedit-Backend +![표지](https://github.com/user-attachments/assets/38077619-6e54-4ef4-b17f-6facb597ef09) -### UMC Wedit-Project 백엔드 레포지토리 -#### [백엔드 노션 링크](https://www.notion.so/Spring-16edb6b0994880d7ad84e491d7440f2c) -## BE Members - | | | | -|:-----:|:-----:|:-----:|:-----:| -|[동구 (김동윤)](https://github.com/dyk-im)|[동동 (김동섭)](https://github.com/dogsub)|[위즈 (이슬기)](https://github.com/leeseulgi0208)|[환이 (최경환)](https://github.com/KyunghwanChoi)| -|리드 👨🏻‍💻|팀원 👨🏻‍💻|팀원 👨🏻‍💻|팀원 👨🏻‍💻| -|화이팅!|화이팅!!|화이팅!!!|화이팅!!!!| -|`인프라`
|`유저`
|`메인 도메인`
|`서브 도메인`
| +## 서비스 소개 +
+ + + +> 개발 기간: 2024. 1. 3 ~ 2025. 2. 21 + +**"Wedit: Wedding + Edit"** + +디지털로 만나는 나만의 특별한 커스텀 모바일 청첩장 + +예비 부부들이 디지털 환경에서 쉽고 빠르게 결혼 소식을 알리고, +자신만의 개성있는 모바일 청첩장을 제작할 수 있도록 돕는 웹 서비스
-
- -## 🛠️ Development Environment 🛠️ -![intellij](https://img.shields.io/badge/intellij-000000?style=for-the-badge&logo=intellijidea&logoColor=white) -![aws](https://img.shields.io/badge/aws-FF9900?style=for-the-badge&logo=amazonec2&logoColor=white) - -## 🥞 Stacks 🥞 -| Name | Description | -| ------------ | ------------- | -| | Java 기반 Spring 베이스로 서버 프로그래밍을 할 수 있는 프레임워크.| -| | 분산 버전 관리 시스템으로, 코드 히스토리 관리와 협업을 효율적으로 지원한다.| -| | 작업 관리 및 문서화를 위한 통합 협업 도구.| -| | 팀 커뮤니케이션 및 실시간 협업을 위한 음성 및 텍스트 기반 플랫폼.| - -## 💻 Convention 💻 -[🔗 Whole Convention Notion Link 🔗](https://www.notion.so/Spring-16edb6b0994880d7ad84e491d7440f2c) - -## 🌲 Branch Convention 🌲 -1. **기본 브랜치 설정** - - main : 배포 가능한 안정적인 코드가 유지되는 브랜치 - - develop: 기본 브랜치로, 기능을 개발하는 브랜치 -2. **작업 순서** - 1. **작업할 이슈 작성** - 2. **작업 브랜치 생성** - - 기능 개발: `feature/#[이슈번호]-title` - - ex) feature/#111-login - - 리팩토링: `refactor/#[이슈번호]-title` - - ex) refactor/#111-login - 3. **생성한 브랜치에서 작업 수행** - 4. **원격 저장소에 작업 브랜치 푸시** - 5. **Pull Request 생성** ---- -## 🧑‍💻 Code Convention 🧑‍💻 -**네이밍 규칙** -- **변수/상수**: 카멜케이스 (예: `userName`) -- **클래스/구조체**: 파스칼케이스 (예: `UserProfile`) -- **함수/메서드**: 동사로 시작하며 카멜케이스 (예: `fetchData()`) - ---- -## 💬 Issue Convention 💬 -## 🫷 PR Convention 🫸 -## 🙏 Commit Convention 🙏 -## 📁 Foldering Convention 📁 ---- +## 👥 팀원 소개 + +### Project Manager + + + + + + + + + + + +
최리원
Project Manager / PO
+ +### Designer + + + + + + + + + + + + +
김민지
Designer
+ +### Frontend + + + + + + + + + + + + + + + + + + + + + + +
메인/로그인 페이지제작/로딩 페이지조회/작성 페이지
이아영이예나최고은
FE LeadFEFE
+ +### Backend + + + + + + + + + + + + + + + + + + + + + + + + + + +
김동윤김동섭이슬기최경환
인프라/정보조회회원청첩장방명록/의사결정
BE LeadBEBEBE
+ +## 📱 주요 기능 + +- **커스텀 청첩장 제작** +스크린샷 2025-03-17 오후 5 05 40 + +- **테마 청첩장 선택 (기본형)** +스크린샷 2025-03-17 오후 5 08 41 + + +- **테마 청첩장 선택 (전통형)** +스크린샷 2025-03-17 오후 5 08 53 + +- **IA** +스크린샷 2025-03-17 오후 5 08 23 + +## 💻 화면 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 전통형 청첩장 + + 기본형 청첩장 +

전통형 청첩장

기본형 청첩장

+ 제작하기 1 + + 제작하기 2 +

제작하기 1

제작하기 2

+ 마이페이지 +

+

+ 분석 보기 +

+

마이페이지

분석 보기

+ 홈 + + 로그인 +

홈

로그인

+ + +## ⚙️ 아키텍처 구조 + +스크린샷 2025-03-17 오후 6 59 57 + + +## 🛠️ 기술 스택 + +### Frontend +![React](https://img.shields.io/badge/React-61DAFB?style=flat&logo=react&logoColor=black) +![Recoil](https://img.shields.io/badge/Recoil-3578E5?style=flat&logo=recoil&logoColor=white) +![Vite](https://img.shields.io/badge/Vite-646CFF?style=flat&logo=vite&logoColor=white) + +### Backend + +![Spring Boot](https://img.shields.io/badge/Spring%20Boot-6DB33F?style=flat&logo=springboot&logoColor=white) +![Spring Security](https://img.shields.io/badge/Spring%20Security-6DB33F?style=flat&logo=springsecurity&logoColor=white) +![JPA](https://img.shields.io/badge/JPA-007396?style=flat&logo=hibernate&logoColor=white) +![Redis](https://img.shields.io/badge/Redis-DC382D?style=flat&logo=redis&logoColor=white) +![MySQL](https://img.shields.io/badge/MySQL-4479A1?style=flat&logo=mysql&logoColor=white) +![JWT](https://img.shields.io/badge/JWT-000000?style=flat&logo=jsonwebtokens&logoColor=white) + +### Infra + +![AWS S3](https://img.shields.io/badge/AWS%20S3-569A31?style=flat&logo=amazons3&logoColor=white) +![AWS EC2](https://img.shields.io/badge/AWS%20EC2-FF9900?style=flat&logo=amazonec2&logoColor=white) +![AWS RDS](https://img.shields.io/badge/Amazon%20RDS-527FFF?style=flat&logo=amazonrds&logoColor=white) +![Docker](https://img.shields.io/badge/Docker-2496ED?style=flat&logo=docker&logoColor=white) +![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-2088FF?style=flat&logo=githubactions&logoColor=white) +![Nginx](https://img.shields.io/badge/Nginx-009639?style=flat&logo=nginx&logoColor=white) +![Netlify](https://img.shields.io/badge/Netlify-00C7B7?style=flat&logo=netlify&logoColor=white) +![Certbot](https://img.shields.io/badge/Certbot-3A579A?style=flat&logo=letsencrypt&logoColor=white) + +### Collaboration Tool +![GitHub](https://img.shields.io/badge/GitHub-181717?style=flat&logo=github&logoColor=white) +![Notion](https://img.shields.io/badge/Notion-000000?style=flat&logo=notion&logoColor=white) +![Discord](https://img.shields.io/badge/Discord-5865F2?style=flat&logo=discord&logoColor=white) + +