Havit-Server

기억하고 싶은 모든 콘텐츠를 내 손 안에, HAVIT

Playstore 에서 다운 받기
Appstore 에서 다운 받기

https://user-images.githubusercontent.com/55099365/150919289-52d35f31-c658-433a-8ffa-d84c8e6e85d8.mp4

쉽고 빠르게 콘텐츠를 저장하고 카테고라이징하며
지식을 놓치지 않도록 리마인드 해줄 수 있는 지식 아카이빙 앱
해빗이 여러분의 성장과 함께 합니다.

SOPT 29th APPJAM

프로젝트 기간: 2022.01.02 ~ 2022.01.22

✅ 서비스 핵심 기능

1. Saving Process

나에게 유용한 콘텐츠를 낮은 뎁스로 간단하게 저장할 수 있습니다.
iOS의 Share Extension, Android의 Intent Filter를 사용하여 홈 화면으로 나가서 앱을 키지 않아도, 콘텐츠를 보다가 사용자가 원하는 카테고리에 저장할 수 있습니다.

2. Category

사용자가 카테고리를 직접 생성하며, 콘텐츠를 원하는대로 카테고라이징 할 수 있습니다. 카테고리는 여러 분야에서 적용 가능한 15개의 3D 아이콘을 제공합니다.

3. Contents

사용자가 저장한 콘텐츠를 잊지 않도록 도와줍니다. 저장 과정에서 기억하기 쉬운 제목으로 수정 가능하고, 저장한 콘텐츠는 직접 지정한 시간에 알림 받을 수 있습니다.

📋 IA

⚙️ Server Architecture

🛠 Development Environment

📁 Foldering

📁 functions _ 
            |_ 📁 api _ 
            |         |_ 📋 index.js
            |         |_ 📁 routes _
            |                      |_ 📋 index.js
            |			   |_ 📁 user
            |                      |_ 📁 content           
            |                      |_ 📁 category
	    |                      |_ 📁 recommendation
            |
            |_ 📁 constants _ 
            |               |_ 📋responseMessage.js
            |               |_ 📋 statusCode.js
            |
            |_ 📁 lib _ 
            |	      |_ 📋 util.js
	    |         |_ 📋 convertSnakeToCamel.js
	    |         |_ 📋 jwtHandlers.js 
	    |
	    |_ 📁 config _ 
            |	        |_ 📋 dbConfig.js
	    |
	    |
	    |_ 📁 middlewares _
	    |                |_ 📋 auth.js
	    |                |_ 📋 slackAPI.js
	    |           
            |
            |_ 📁 db _
                      |_ 📋 index.js
                      |_ 📋 db.js
                      |_ 📋 user.js
                      |_ 📋 category.js
		      |_ 📋 content.js
		      |_ 📋 categoryContent.js
		      |_ 📋 recommendation.js

📌 Dependencies Module

{
  "dependencies": {
    "axios": "^0.24.0",
    "busboy": "^0.3.1",
    "cookie-parser": "^1.4.6",
    "cors": "^2.8.5",
    "dayjs": "^1.10.7",
    "dotenv": "^10.0.0",
    "eslint-config-prettier": "^8.3.0",
    "express": "^4.17.2",
    "firebase-admin": "^9.8.0",
    "firebase-functions": "^3.14.1",
    "helmet": "^5.0.1",
    "hpp": "^0.2.3",
    "jsonwebtoken": "^8.5.1",
    "lodash": "^4.17.21",
    "open-graph-scraper": "^4.11.0",
    "pg": "^8.7.1"
  },
  "devDependencies": {
    "chai": "^4.3.4",
    "eslint": "^7.6.0",
    "eslint-config-google": "^0.14.0",
    "firebase-functions-test": "^0.2.0",
    "mocha": "^9.1.4",
    "supertest": "^6.2.2"
  }
}

📌 담당 API 및 구현 진척도

FCM-Push-Server Gihub Link

📌 Mocha API 유닛 테스트

결과 보고서

📌 Branch Strategy

 1. local - feature에서 각자 기능 작업
 2. 작업 완료 후 local - develop (ex. jobchae) 에 PR 후 Merge
 3. 이후 remote - develop 으로 PR
 4. 코드 리뷰 후 Confirm 받고 Merge
 5. remote - develop 에 Merge 될 때 마다 모든 팀원 remote - develop pull 받아 최신 상태 유지

📌 Commit Convention

[TAG] 메시지

📌 Coding Convention

  // 한줄 주석일 때
  /**
  * 여러줄
  * 주석일 때
  */

  /**
  * api get /travel/:groupNumber
  * 그룹 여행 정보 가져오기

  if (a === 5) {
	  // 주석
  }

// 한줄 if 문 - 여러 줄로 작성
 if(trigger) {
   return;
 }

// 괄호 사용 한칸 띄우고 사용한다.
 if (left === true) {
    return;
 }

// 띄어쓰기
 if (a === 5) { // 양쪽 사이로 띄어쓰기
    return;  
 }

👩🏻‍💻 Developers

주효식	채정아
HYOSITIVE	jokj624