/BillyZip_SERVER

Here is BillyZip Project Repository. Please Check a 'README.md' File

Primary LanguageJavaScript

billyzip_logo

Billy Zip

Billy Zip은 새로운 개념의 구독형 주거 서비스 제공하는 모바일 어플리케이션 프로젝트 입니다.

이사할 때마다 전세? 월세? 보증금? 계약은 어떻게...? 부동산 매물마다 너무 복잡하지 않으신가요? 🤬

Billy Zip을 이용하면 부동산 또는 집주인과의 번거롭고, 복잡한 계약 관계없이 살고 싶은 곳이 있으면 예약 후 마음 편히 거주할 수 있습니다. 🥰


프로젝트 개요

프로젝트 기간 : 2020.01.31 ~ 2020.02.25

서비스 종류 : Mobile Application

프로젝트 참여 인원 : Front-End 1명 / Full-Stack 2명

  • 조성철 (팀장, Full-Stack)
    • Front : 검색 기능 구현, 포럼 구현
      • 유저에게 보다 적합한 부동산 매물 제공하기 위해 퀵 서치 & 맵 서치 컴포넌트 구현
      • 필요한 요건의 매물을 찾을 수 있도록 필터링 컴포넌트 구현
    • Back
      • 전체적인 서버 구조 및 기능 구현, REST API 구조 구현
      • Typescript & Express로 @REST API를 활용하여 하우스, 리뷰, 유저정보의 CRUD 기능 구현
      • JWT 토큰 인증 과정을 Express Middleware로 하는 인증체계 구축
      • Twilio Programmable SMS API를 이용한 인증번호 문자 전송 및 인증 확인 모듈 구축
      • Socket.io를 이용해 유저 to 호스트, 유저 to 유저간 의사소통이 가능한 실시간 채팅 기능 구현
      • TypeORM의 Active Record 방식을 통한 DB 제어와 자체 알고리즘을 이용해 하우스 검색 기능 구현
    • 배포
      • Server : AWS EC2
      • DB : AWS RDS

  • 김보미 (팀원, Full-Stack)
    • 회원 서버 API 작성, 회원 정보 화면 구현
      • 회원가입 / 로그인 / 로그 아웃 / 탈퇴 서버API 연결
      • 회원 정보 수정(비밀번호 / 휴대폰 번호 변경) 서버 API 연결 및 화면 구현
      • 현재 구독 모델 / 살고 있는 집 서버 API 연결 및 화면 구현
      • 결제 서버 API 연결 및 화면 구성

  • 임현성 (팀원, Front-End)
    • 전반적인 클라이언트 구조 및 기능 구현, 전체 디자인 구현
      • 전체 네비게이션 설계 및 구현
      • 클라이언트 전반적인 UI/UX 구현
      • 로그인 / 회원가입 / 로그아웃 기능 구현
      • 홈 화면(추천매물 / 매물 종류별) / 매물 종류별 리스트 화면 구현
      • 즐겨찾기 토글 기능 구현 및 즐겨찾기 화면 구현
      • Hosting CRUD 기능 구현 (호스팅 작성 / 호스팅 상세 화면 / 호스팅 수정 / 삭제)
      • 내 호스팅 관리 화면 구현
      • 구독 신청 수락/거절 기능 및 구독 신청 현황 화면 구현
      • 리뷰 화면 및 리뷰 등록/삭제 기능 구현 (별점 평가 및 코멘트 기능)

Billy Zip 주요 기능

  • 핸드폰 인증 기반 회원가입 / 로그인 / 로그아웃 / 개인정보 수정 / 회원탈퇴
  • 매물 등록/수정/삭제/상세 정보 열람
  • 매물 즐겨찾기 등록 / 삭제
  • 매물 리뷰 (평점 평가 및 코멘트) 등록 및 삭제
  • 구독 신청 및 신청 수락 / 거절
  • 매물 검색 / 상세 검색 / 지도 검색
  • 포럼을 통한 의견 공유
  • 결제 시스템 (테스트 결제??)

프로젝트 관리

  • Notion을 이용하여 프로젝트 전반적인 기획 및 관리

    • team rule, step, task, api 문서 등

  • Miro를 이용하여 프로젝트 전체 레이아웃 설계

  • dbdiagram.io를 이용하여 데이터베이스 설계

  • 애자일 스크럼 방식을 이용하여 스프린트 단위의 개발 진행관리

  • ESLint, Prettier를 이용하여 코드 스타일 통일


사용한 기술 스택

Common

  • TypeScript
  • Node.js
  • Soket.io

Front-End

  • React Native (EXPO)
  • React Hooks
  • React Navigation
  • React Native Elements
  • Axios
  • Google maps API

Back-End

  • Express
  • TypeORM
  • JWT
  • Twilio
  • Multer
  • MySQL

Development Tool

  • Git
  • AWS (S3, EC2, RDS)

프로젝트 아키텍쳐

아키텍쳐


Billy Zip 시연 영상

이미지 텍스트



Back-End

Directory Structure

Billy-Zip server
├── .eslintignore
├── .eslintrc
├── .gitignore
├── .prettierrc
├── README.md
├── node_modules
├── ormconfig.js
├── package-lock.json
├── package.json
├── src
│   ├── config
│   │   ├── awsconfig.json
│   │   ├── bcrypt.ts
│   │   └── jwt.ts
│   ├── controllers
│   │   ├── application.ts
│   │   ├── auth.ts
│   │   ├── favs.ts
│   │   ├── forum.ts
│   │   ├── houses.ts
│   │   ├── payment.ts
│   │   ├── review.ts
│   │   └── users.ts
│   ├── entities
│   │   ├── Amenity.ts
│   │   ├── Application.ts
│   │   ├── Favorite.ts
│   │   ├── Forum.ts
│   │   ├── House.ts
│   │   ├── Image.ts
│   │   ├── JoinForum.ts
│   │   ├── Payment.ts
│   │   ├── Review.ts
│   │   └── User.ts
│   ├── index.ts
│   ├── middleware
│   │   └── authChecker.ts
│   ├── routes
│   │   ├── application.ts
│   │   ├── auth.ts
│   │   ├── favs.ts
│   │   ├── forum.ts
│   │   ├── houses.ts
│   │   ├── payment.ts
│   │   └── users.ts
│   ├── server.ts
│   ├── socket.ts
│   └── utils
│       ├── avgRatingHelper.ts
│       ├── convertHouseProperties.ts
│       ├── decodeHelper.ts
│       ├── ratingRangeHelper.ts
│       └── twilioHelper.ts
└── tsconfig.json

API Documentation

https://documenter.getpostman.com/view/9956944/SzKZsbag?version=latest


DB Scheme

DB Scheme Description: https://docs.google.com/spreadsheets/d/1vzdjWw64ekSy2aPq3-5ePWHsK1ncYsu8RKfrPqGKWVU/edit?usp=sharing

billyZip