Skip to content

Yeom-JinHo/Mattro

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🥄 맛트로 mattro 🍴



리뷰 텍스트를 활용한 지하철 노선별 맛집 추천 서비스



🍴 팀원 소개

삼성 청년 SW 7기 광주 2반 특화 프로젝트 C206 - 당근

조성민 박상현 박세호 염진호 윤정원 이정민
BE BE BE FE FE FE


🍴 프로젝트 소개

  • Mattro 는 리뷰 텍스트를 활용한 수도권 지하철 역 근처 맛집 추천 서비스 입니다.
  • 사용자가 지하철 역을 선택시, 해당 역 인근에 위치한 맛집을 추천합니다.
  • 선택 서베이를 제공하여 해당 결과를 토대로 사용자 선택에 따른 맛집을 추천합니다.
  • 다수의 사용자가 접속 가능한 지하철 미니게임을 제공합니다.


1. 📂 파일구조


프론트 파일 구조


  root
    ├── public                        # 이미지, 사운드 파일 관련
    ├── components                    # 컴포넌트
    │     └── layouts                 # 공통 레이아웃 관련
    ├── constants                     # typescript type 및 데이터 관련
    ├── pages
    │     ├── api                     # API 관련
    │     ├── game                    # 게임 페이지 관련
    │     │      └── ...
    │     ├── subway                  # 노션별 맛집 추천 페이지 관련
    │     │      └── ...
    │     ├── theme                   # 오늘의 맛집 추천 페이지 관련
    │     │      └── ...
    │     ├── index.tsx               # 메인페이지 관련
    │     ├── _app.tsx                # 각 페이지별 공통 부분 리펙토링
    │     └──  _document.tsx           # meta 태그 정의 및 전체 페이지 구조
    └── styles                        # 스타일 관련 파일 모음
          └── ...

백엔드 파일 구조


mattro
└─src
    └─main
         ├─java
         │  └─com.carrot.mattro
         │    ├─controller         # Http 요청과 응답을 위한 클래스
         |    |   └─...
         │    ├─domain
         │    │    ├─entity        # JPA에서 사용할 엔티티
         │    │    │    └─...
         │    │    ├─repository    # DB에 접근하는 Interface 
         │    │    │    └─...
         │    ├─DTO                # 데이터 전송 객체
         │    │    └─...
         │    ├─Repository         # DB에 접근하는 Interface
         │    │    └─...
         │    ├─service            # Repository와 DTO를 통해 DB와 controller 연결
         │    │    └─...
         │    ├─CacheConfig        # 캐시 적용을 위한 옵션 설정
         │    └─MattroApplication  # application 파일
         └─resources               # application 필요한 옵션 지정


2. 📂 백엔드 구조


ERD 구조

erd


아키텍처 구조


3. 📂 기능 구현

메인 페이지


  • 메인 홈 메인 홈

  • 네비게이션 네비게이션

  • 노선별 추천 노선별 추천

  • 노선별 추천 결과 노선별 추천 결과

  • 설문 추천 메인 설문 추천 메인

  • 추천을 위한 설문 추천을 위한 설문

  • 설문 추천 결과 설문 추천 결과

  • 게임 메인 게임 메인

  • 게임 방 목록 게임 방 목록

  • 개임 로비 개임 로비

  • 게임 준비 게임 준비

  • 게임 중 게임 중


4. 📂 프로젝트 소개 영상



5. 📂 프로젝트 관련 문서


🎨 프로토타입, 디자인

📡 요구사항 명세서

📋 API 명세서