README.md

🍭 스윗한 마음이 모여 하나의 선물이 되다,
선물 준비 서비스 SWEET

배포 링크
https://www.sweetgift.kr/

📄 목차

• 📄 목차
• ✍🏻 프로젝트 개요
• 🥰 팀원 소개
• 🍭 핵심 기능
  • 소셜 로그인 기능
  • 선물 준비 모임 개설 기능
  • 선물 준비 모임 공유 기능
  • 선물 링크 등록 기능
  • 선물 선정 토너먼트 기능
  • 마이페이지 기능
• 🍪 기술 스택
• 🦾 시스템 아키텍처
  • 폴더 구조
  • 아키텍처 구조
  • ERD
  • 실행 방법
• 🍰 Git & Code Convention
• 🍩 API Specification

✍🏻 프로젝트 개요

❤️ 33rd SOPT 웹잼 Team Sweet

스윗은 여러 명의 사람들이 모여 한 사람의 선물을 준비할 때, 모두의 의견을 모아 하나의 선물을 고르고 정성까지 전달하는 웹 서비스입니다.

🥰 팀원 소개

박지영(ziiyouth)	송하연(hysong4u)
Back-end	Back-end

🍭 핵심 기능

소셜 로그인 기능

카카오톡 소셜 로그인을 통해 간편한 회원가입이 가능합니다.

선물 준비 모임 개설 기능

이름, 썸네일, 토너먼트 기간 등의 정보 입력을 통해 선물 준비 모임을 개설합니다.

선물 준비 모임 공유 기능

초대 코드 링크를 통해, 혹은 카카오톡으로 간편한 초대가 가능합니다.

선물 링크 등록 기능

선물 링크 입력만 하면, 자동으로 오픈그래프 메타태그를 통해 사진과 상품명을 추출해 등록해줍니다.

선물 선정 토너먼트 기능

선물 선정을 토너먼트 형식으로 흥미롭게 진행합니다. 마감 시간 후에 전체 순위를 확인할 수 있습니다.

마이페이지 기능

내가 준비했던/준비하고 있는 선물 모임을 찾아볼 수 있습니다.

🍪 기술 스택

🖥 Backend

역할	종류
Framework
Database
Database Service
Programming Language
API
Version Control
CICD

🖥 Common

역할	종류
협업 관리
디자인
소통

🦾 시스템 아키텍처

📂 폴더 구조

📂 src
┣ 📂 java.org.sopt.sweet
┃  ┣ 📂 domain
┃  ┃  ┣ 📂 sample
┃  ┃  ┃  ┣ 📂 controller
┃  ┃  ┃  ┣ 📂 entity
┃  ┃  ┃  ┣ 📂 dto
┃  ┃  ┃  ┃  ┣ 📂 request
┃  ┃  ┃  ┃  ┣ 📂 response
┃  ┃  ┃  ┣ 📂 service
┃  ┃  ┃  ┣ 📂 domain
┃  ┃  ┃  ┣ 📂 repository
┃  ┣ 📂 global
┃  ┃  ┣ 📂 common
┃  ┃  ┣ 📂 config
┃  ┃  ┃  ┣ 📂 auth
┃  ┃  ┣ 📂 error
┃  ┃  ┃  ┣ 📂 dto
┃  ┃  ┃  ┣ 📂 exception
┃  ┃  ┃  ┣ 📂 handler
┃  ┃  ┣ 📂 external
┣ 📂 resources
┃  ┣ application.yml
┣ SweetApplication.class

📂 아키텍처 구조

📢 ERD

📢 실행 방법

1. git clone을 진행한다.
2. resources 폴더에 application.yml을 추가한다.
3. build/libs 디렉터리로 이동해 java -jar sweet-0.0.1-SNAPSHOT.jar 명령어를 실행한다.

🍰 Git & Code Convention

✨ 스윗 서버의 코드 컨벤션 보러가기 (클릭!)

✨ 스윗 서버의 기술 스택 보러가기 (클릭!)