SGBInside-Server

✨ 생기부 인사이드는?

생기부인사이드는 고등학생을 위한 생활기록부 기록 종합 가이드 서비스입니다.

아래의 4개의 생활기록부 기록 주요 항목들을 기록, 관리합니다.

창의적 체험활동

세부능력 및 특기사항

독서활동

수상경력

타겟 유저

기록과 성찰의 기회가 부족하고, 학생부 종합전형을 스스로 준비하는 것의 어려움을 겪고 있는 고등학생을 주요 타겟 유저로 설정합니다.
이외에, 고교 활동 경험을 공유하고 멘토링을 제공하고자 하는 대학생 멘토 또한 타겟 유저로 설정합니다.

서비스 목표

1. 학생이 주체가 되는 생활기록부 관리
부모님, 선생님, 또는 사설 업체의 도움을 받기에 앞서 스스로 생활기록부를 관리할 수 있도록 합니다.

2. 주기적인 활동 기록을 통한 전략적 입시 대비
담임 선생님께 생활기록부 문구를 제출하거나, 자기소개서를 작성할 시에 미리 기록된 데이터를 참고할 수 있도록 합니다.

🎁 주요 기능

✏ (고등학생) 생활기록부 4개 항목 활동 기록하기

생활기록부 4개 항목별 활동을 폼 형태 UI로 기록합니다.
기재요령 확인하기 버튼을 클릭해 생활기록부 기재 요령을 함께 확인할 수 있습니다.

세부내용 조회

창의적 체험활동 기록하기

교과별 세부능력 및 특기사항 기록하기

수상경력 기록하기

독서활동 기록하기

📚 (고등학생) 마이페이지에서 기록한 활동 관리하기

토글을 통해 학기별로, 버튼을 통해 생활기록부 항목별로 분류하여 기록한 활동을 조회합니다.
개별 활동을 클릭해 작성한 세부 내용을 조회/수정/삭제할 수 있으며, 텍스트 내용을 클립보드에 복사할 수 있습니다.

세부 내용 조회

🎅 (고등학생) 생활기록부 4개 항목 기록을 보충하는 추천 시스템

고등학생 유저는 생활기록부 4개 항목별로 필요할 경우 추가적인 정보를 제공받을 수 있습니다.

세부 내용 조회

창의적 체험활동
- 진학 희망 학과별 진로활동 추천 (커리어넷 학과정보 API 활용)
- 대학생 멘토의 창의적 체험활동 기록 조회
세부능력 및 특기사항
- 진학 희망 학과별 집중 관리 교과목 추천 (커리어넷 학과정보 API 활용)
수상경력
- 대학생 멘토의 수상경력 기록 조회
독서활동
- 진학 희망 학과별 추천 도서 목록 조회 (전라북도 교육청 제공 전공별 권장도서 목록 활용)

✏ (대학생 멘토) 생활기록부 창의적 체험활동, 수상경력 기록하기

대학생 멘토 유저는 고등학교 재학 당시 창의적 체험활동, 수상경력을 기록하여 생기부 인사이드의 데이터베이스에 기여합니다.
멘토 유저를 고려한 별도의 비즈니스 모델을 반영하지는 않았으나, 포인트 및 리워드 지급 제도의 병행을 염두에 두고 서비스를 기획하였습니다.

세부 내용 조회

창의적 체험활동 기록하기

수상경력 기록하기

📚 (대학생 멘토) 마이페이지에서 기록한 활동 관리하기

세부 내용 조회

📑 요구사항 명세서

명세서 내용이 길어 노션 참고를 부탁드리겠습니다.
요구사항 명세서 Link

📜 API 명세서

API별 세부 명세서는 노션 링크를 참고 부탁드립니다.
https://brick-rainbow-789.notion.site/API-24561ec6be1b4147b93b1f678919fd3b?pvs=74

회원 API

기능	HTTP method	url
회원가입	POST	`/auth`
로그인	POST	`/auth/signin`

생활기록부 항목별 기록 API

기능	HTTP method	url
고등학생 및 대학생 멘토 창의적 체험활동 기록	POST	`/activity/creative`
고등학생 세부능력 및 특기시항 기록	POST	`/activity/subject`
고등학생 세부능력 및 특기시항 기록	POST	`/activity/subject`
고등학생 및 대학생 멘토 수상경력 기록	POST	`/activity/prize`
고등학생 독서활동 기록	POST	`/activity/book`

생활기록부 항목별 추천 정보 조회 API

기능	HTTP method	url
고등학생 대상 추천 창의적 체험활동 전체 조회	POST	`/recommend/creative?sort=`
고등학생 대상 추천 창의적 체험활동 개별 조회	GET	`/recommend/creative/:activityId`
고등학생 대상 대회 준비 관련 팁 전체 조회	POST	`/recommend/prize`
고등학생 대상 대회 준비 관련 팁 개별 조회	GET	`/recommend/prize/:activityId`
고등학생 대상 진학 희망 학과별 권장도서 전체 조회	POST	`/recommend/book`

마이페이지 API

기능	HTTP method	url
마이페이지 계정정보 및 전체 활동 조회	POST	`/mypage?sort=value&semester=value`
마이페이지 창의적 체험활동 기록 개별 조회	GET	`/mypage/creative/:activityId`
마이페이지 세부능력 및 특기사항 기록 개별 조회	GET	`/mypage/subject/:activityId`
마이페이지 독서활동 기록 개별 조회	GET	`/mypage/book/:activityId`
마이페이지 수상경력 기록 개별 조회	GET	`/mypage/prize/:activityId`
마이페이지 창의적 체험활동 기록 개별 수정	PUT	`/mypage/creative/:activityId`
마이페이지 세부능력 및 특기사항 기록 개별 수정	PUT	`/mypage/subject/:activityId`
마이페이지 독서활동 기록 개별 수정	PUT	`/mypage/book/:activityId`
마이페이지 수상경력 기록 개별 수정	PUT	`/mypage/prize/:activityId`
마이페이지 창의적 체험활동 기록 개별 삭제	DELETE	`/mypage/creative/:activityId`
마이페이지 세부능력 및 특기사항 기록 개별 삭제	DELETE	`/mypage/subject/:activityId`
마이페이지 독서활동 기록 개별 삭제	DELETE	`/mypage/book/:activityId`
마이페이지 수상경력 기록 개별 삭제	DELETE	`/mypage/prize/:activityId`

🎨 Flow Chart

1. 고등학생 유저 플로우

이미지 확인

2. 대학생 멘토 유저 플로우

이미지 확인

⚙️ 시스템 설계도

📦 Project Structure

디렉토리 구조

│   app.ts
│   index.ts
│
├───books
│       recommendBooks.json
│
├───config
│       index.ts
│       s3Config.ts
│
├───constants
│       index.ts
│       response.ts
│       responseMessage.ts
│       statusCode.ts
│       tokenType.ts
│       type.d.ts
│
├───controller
│       activityController.ts
│       index.ts
│       mypageController.ts
│       recommendController.ts
│       userController.ts
│
├───interfaces
│   ├───activity
│   │       BookActivityCreateDTO.ts
│   │       CreativeActivityCreateDTO.ts
│   │       PrizeActivityCreateDTO.ts
│   │       SubjectDetailedActivityCreateDTO.ts
│   │
│   └───user
│           UserCreateDTO.ts
│           UserSignInDTO.ts
│
├───middlewares
│       auth.ts
│       index.ts
│       upload.ts
│
├───modules
│       jwtHandler.ts
│
├───router
│       activityRouter.ts
│       index.ts
│       mypageRouter.ts
│       recommendRouter.ts
│       userRouter.ts
│
└───service
        activityService.ts
        index.ts
        mypageService.ts
        recommendService.ts
        userService.ts

🛠 Tech Stack

Language & Framework

Database

배포 환경

ETC

IDE

FE와의 협업 툴

🌳 Branch Strategy

브랜치는 dev branch, feature branch 총 2개의 브랜치를 사용합니다.

✏ Commit Message Convention

Commit Type	Desc
[FEAT]	새로운 기능 추가
[FIX]	버그 수정
[CHORE]	패키지 매니저 수정 (Dockerfile, gradle, sh, yml) 및 기타 사소한 변경
[HOTFIX]	급하게 치명적인 버그를 고쳐야 하는 경우

Team-SGBInside/SGBInside-Server

SGBInside-Server

✨ 생기부 인사이드는?

🎁 주요 기능

✏ (고등학생) 생활기록부 4개 항목 활동 기록하기

📚 (고등학생) 마이페이지에서 기록한 활동 관리하기

🎅 (고등학생) 생활기록부 4개 항목 기록을 보충하는 추천 시스템

✏ (대학생 멘토) 생활기록부 창의적 체험활동, 수상경력 기록하기

📚 (대학생 멘토) 마이페이지에서 기록한 활동 관리하기

📑 요구사항 명세서

📜 API 명세서

회원 API

생활기록부 항목별 기록 API

생활기록부 항목별 추천 정보 조회 API

마이페이지 API

🎨 Flow Chart

1. 고등학생 유저 플로우

2. 대학생 멘토 유저 플로우

⚙️ 시스템 설계도

📦 Project Structure

🛠 Tech Stack

🌳 Branch Strategy

✏ Commit Message Convention