Skip to content

Latest commit

 

History

History
417 lines (363 loc) · 13.5 KB

README.md

File metadata and controls

417 lines (363 loc) · 13.5 KB
Raw

DragMe-Server

드래그 기반의 유연한 시간관리로 만들어가는 주체적인 삶의 계획표

DragMe_Poster

SOPT 30th - THE SOPT App-Jam

프로젝트 기간: 2022.07.04 ~ 2022.07.23

✅ 서비스 핵심 기능

1. 계획 블록 생성

하루 동안의 계획을 계획 블록에 작성해 저장할 수 있습니다. 8가지 컬러칩을 통해 계획 블록마다 색상을 지정하고 빠르게 구분합니다. 계획 내에서 상위계획과 하위계획을 설정해 체계적으로 계획을 관리할 수 있습니다.

2. 시간 블록 드래그

계획 블록에 할당된 시간 블록을 오른쪽으로 드래그하며 시간 계획을 세웁니다. 계획을 완료한 뒤에 실제로 활용한 시간을 한번 더 표시할 수 있습니다. 왼쪽으로 드래그하며 표시한 시간을 쉽게 삭제합니다.

3. 계획 블록 Drag and Drop

자주 세우는 계획을 설정하고 Drag and Drop을 통해 빠르게 계획 블록을 추가합니다. 우회하기 섹션에 계획 블록을 Drag and Drop 하면서 오늘의 계획 블록을 잠시 미뤄둘 수 있습니다.

4. 회고와 목표

일별로 이모티콘, 한 줄 정도의 간단한 회고를 통해 하루동안의 계획을 정리하고 마무리합니다. 이번주 목표와 이번달 목표를 작성해 저장합니다.

🛠 Development Environment

Typescript NodeJS Express MongoDB AWS

📑 Collection

const UserSchema = new mongoose.Schema(
  {
    name: {
      type: String,
      required: true,
    },
    email: {
      type: String,
      required: true,
    },
    goal: {
      type: String,
    },
    badge: {
      type: String,
      required: true,
    },
  },
  {
    timestamps: true,
  }
);
const ScheduleSchema = new mongoose.Schema(
  {
    date: {
      type: String,
      required: true,
    },
    estimatedTime: {
      type: [Number],
    },
    usedTime: {
      type: [Number],
    },
    title: {
      type: String,
      required: true,
    },
    subSchedules: {
      type: [mongoose.Types.ObjectId],
      ref: 'Schedule',
    },
    categoryColorCode: {
      type: String,
    },
    userId: {
      type: mongoose.Types.ObjectId,
      required: true,
      ref: 'User',
    },
    isCompleted: {
      type: Boolean,
      default: false,
    },
    isReschedule: {
      type: Boolean,
      default: false,
    },
    isRoutine: {
      type: Boolean,
      default: false,
    },
    orderIndex: {
      type: Number,
    },
  },
  {
    timestamps: true,
  }
);
const InformationSchema = new mongoose.Schema(
  {
    date: {
      type: String,
      required: true,
    },
    type: {
      type: String,
      required: true,
    },
    value: {
      type: String,
    },
    userId: {
      type: mongoose.Types.ObjectId,
      required: true,
      ref: 'User',
    },
  },
  {
    timestamps: true,
  }
);

📏 Code Convention

변수명
  1. Camel Case 사용
  • lower Camel Case
  1. 함수의 경우 동사+명사 사용
  • ex) getInformation()
  1. flag로 사용 되는 변수는 조동사 + flag 종류로 구성
  • ex) isNum
  1. 약어는 되도록 사용하지 않는다.
  • 부득이하게 약어가 필요하다고 판단되는 경우 팀원과 상의를 거친다.
주석
  1. 한줄 주석은 // 를 사용한다.
// 한줄 주석일 때
/**
 * 여러줄
 * 주석일 때
 */
  1. 함수에 대한 주석
/**
 * @route Method /Route
 * @desc Function Description
 * @access Public
 */
  1. Bracket 사용 시 내부에 주석을 작성한다.
if (a == 5) {
  // 주석
}
Bracket
  1. 한줄 if 문은 여러 줄로 작성한다.
// 한줄 if 문 - 여러 줄로 작성
if (trigger) {
  return;
}
  1. 괄호는 한칸 띄우고 사용한다.
// 괄호 사용 한칸 띄우고 사용한다.
if (left == true) {
  return;
}
  1. Bracket 양쪽 사이를 띄어서 사용한다.
const { userId } = request.user;
비동기 함수의 사용
  1. async, await 함수 사용을 지향한다.
  2. Promise 사용은 지양한다.
  3. 다만 로직을 짜는 데 있어 promise를 불가피하게 사용할 경우, 주석으로 표시하고 commit에 그 이유를 작성한다.

📌 Commit Convention

[TAG] 메시지
태그 이름 설명
[CHORE] 코드 수정, 내부 파일 수정
[FEAT] 새로운 기능 구현
[ADD] FEAT 이외의 부수적인 코드 추가, 라이브러리 추가, 새로운 파일 생성
[HOTFIX] issue나 QA에서 급한 버그 수정에 사용
[FIX] 버그, 오류 해결
[DEL] 쓸모 없는 코드 삭제
[DOCS] README나 WIKI 등의 문서 개정
[CORRECT] 주로 문법의 오류나 타입의 변경, 이름 변경에 사용
[MOVE] 프로젝트 내 파일이나 코드의 이동
[RENAME] 파일 이름 변경이 있을 때 사용
[IMPROVE] 향상이 있을 때 사용
[REFACTOR] 전면 수정이 있을 때 사용

🌿 Branch Strategy

Git Workflow 
main → develop → feature_# / fix_#
feature, fix 이하 번호는 issue 번호에 맞게 생성

1. issue 생성
2. local - feature_# / fix_# 에서 각자 기능 작업
3. remote - feature_# / fix_# 에 Push
4. remote - develop 으로 PR
5. 코드 리뷰 후 Confirm 받고 remote - develop Merge
6. remote - develop 에 Merge 될 때 마다 모든 팀원 local - develop pull 받아 최신 상태 유지
Branch Name 설명
main 초기 세팅 존재
develop 구현 완료 브랜치
feature_# 이슈 별 기능 구현 브랜치
fix_# 이슈 별 픽스 브랜치

📁 Project Foldering

🗃️ 3-Layer Architecture 적용

📁 src _
|_ 📁 config _
             |_ 📋 index.ts
|_ 📁 controllers _
                  |_ 📋 index.ts
                  |_ 📋 InformationController.ts
                  |_ 📋 ScheduleController.ts
                  |_ 📋 UserController.ts
|_ 📁 interfaces _
                 |_ 📁 information
                 |_ 📁 schedule
                 |_ 📁 user
|_ 📁 loaders _
              |_ 📋 db.ts
|_ 📁 models _
             |_ 📋 Information.ts
             |_ 📋 Schedule.ts
             |_ 📋 User.ts
|_ 📁 modules _
              |_ 📋 responseMessage.ts
              |_ 📋 returnToSlackMessage.ts
              |_ 📋 slackAPI.ts
              |_ 📋 statusCode.ts
              |_ 📋 util.ts
|_ 📁 routes _
             |_ 📋 index.ts
             |_ 📋 InformationRouter.ts
             |_ 📋 ScheduleRouter.ts
             |_ 📋 UserRouter.ts
|_ 📁 services _
               |_ 📋 index.ts
               |_ 📋 InformationService.ts
               |_ 📋 ScheduleService.ts
               |_ 📋 UserService.ts
|_ 📋 index.ts

🔎 Dependencies Module

{
  "name": "node-typescript-init",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "dev": "nodemon",
    "build": "tsc && node dist",
    "prepare": "husky install",
    "test": "cross-env NODE_ENV=test jest --setupFiles dotenv/config --forceExit --detectOpenHandles"
  },
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "@types/express": "^4.17.13",
    "@types/jest": "^28.1.6",
    "@types/mongoose": "^5.11.97",
    "@types/node": "^17.0.25",
    "@types/supertest": "^2.0.12",
    "@typescript-eslint/eslint-plugin": "^5.30.6",
    "@typescript-eslint/parser": "^5.30.6",
    "babel-jest": "^28.1.3",
    "husky": "^8.0.0",
    "jest": "^28.1.3",
    "nodemon": "^2.0.15",
    "supertest": "^6.2.4",
    "ts-jest": "^28.0.7",
    "ts-node": "^10.7.0",
    "typescript": "^4.6.3"
  },
  "dependencies": {
    "@babel/core": "^7.18.9",
    "@babel/preset-env": "^7.18.9",
    "@types/cors": "^2.8.12",
    "@types/lodash": "^4.14.182",
    "axios": "^0.27.2",
    "cors": "^2.8.5",
    "cross-env": "^7.0.3",
    "dotenv": "^16.0.1",
    "eslint": "^8.19.0",
    "eslint-config-prettier": "^8.5.0",
    "eslint-plugin-prettier": "^4.2.1",
    "express": "^4.17.3",
    "express-validator": "^6.14.0",
    "lodash": "^4.17.21",
    "mongoose": "^6.4.4",
    "prettier": "^2.7.1"
  }
}

⚙️ Server Architecture

server_architecture

💼 Roles (API) & Progess Status

기능명 담당자 완료 여부
일간 계획 계획블록 리스트 조회 주효식 ✅
일간 계획 정보 조회 강민재 ✅
정보 작성 주효식, 강민재 ✅
미뤄진 계획블록 목록 조회 강민재 ✅
계획블록 미루기 강민재 ✅
미룬 계획블록 계획표로 옮기기 주효식 ✅
계획블록 완료하기 강민재 ✅
계획블록 생성 주효식 ✅
계획블록 시간 설정 강민재 ✅
계획블록 시간 삭제 강민재 ✅
계획블록 삭제 강민재 ✅
계획블록 수정 주효식 ✅
하위 계획블록 조회 강민재 ✅
날짜별 일정 존재 여부 조회 주효식 ✅
자주 사용하는 계획 조회 주효식 ✅
계획블록 카테고리 변경 주효식 ✅
자주 사용하는 계획 등록 주효식 ✅
자주 사용하는 계획블록 계획표로 옮기기 강민재 ✅
계획블록 이름 수정 주효식 ✅
주간 계획 계획블록 리스트 조회 주효식 ✅
주간 계획 이모지 조회 주효식 ✅
계획블록 요일 이동 강민재 ✅
계획블록 순서 변경 주효식 ✅
주간 목표 조회 강민재 ✅
월간 목표 조회 강민재 ✅

🧑‍💻 Developers

주효식 HYOSITIVE 강민재 m1njae

광기