화면구성

메인화면	마이페이지	급식
커뮤니티	시간표	일정관리
일정등록	대학정보

0. Getting Started (시작하기)

$ yarn start

서비스 링크

1. Project Overview (프로젝트 개요)

• 프로젝트 이름: 구덕인
• 프로젝트 설명: 구덕고등학교 학생들을 위한 학생 관리 시스템 및 커뮤니티

2. Team Members (팀원 및 팀 소개)

이은호
풀스택

3. Key Features (주요 기능)

• 회원가입:

  • 회원가입 시 DB에 유저정보가 등록됩니다.
  • 학교에서 제공하는 year학년반@gudeok.hs.kr 형태의 이메일 인증이필요합니다.

• 로그인:

  • 사용자 인증 정보를 통해 로그인합니다.
  • 로그인 상태는 JWT로 관리합니다

• 급식:

  • 금주 식단 목록을 스왑 가능한 목록으로 보여줍니다.
  • 중식/석식 버튼으로 구분해서 확인 가능합니다

• 커뮤니티:

  • 사용중인 계정 학년 바탕으로 각 학년 게시판이 나뉩니다.
    • 자유게시판, N학년게시판, 질문게시판
  • 글쓰기, 검색, 수정, 삭제 가능합니다.
  • 작성된 글에 댓글과 좋아요, 싫어요를 할 수 있습니다.
  • 좋아요가 5개 이상시 추천글에 등록됩니다.

• 시간표:

  • 사용중인 계정 학년과 반을 바탕으로 금주 시간표를 가져옵니다.
  • 한 시간에 여러가지 수업이 존재할 시 설정에서 선택가능한 수업을 매핑할 수 있습니다.

• 일정 관리:

  • 우리 학교의 1년 학사일정을 바탕으로 기본 일정이 추가되어있습니다.
  • 원하는 날짜와 시간을 등록해서 자신의 일정을 관리할 수 있습니다.

• NEIS PLUS 연동:

  • NEIS PLUS 아이디, 비밀번호 입력 시 자신의 내신 점수를 가져와 평균 내신점수를 계산합니다.

• 마이 페이지

  • 한달에 한번 자신의 닉네임을 변경할 수 있습니다.
  • 자신의 프로필 이미지를 변경할 수 있습니다. gif, animation webp를 지원합니다.
  • NEIS PLUS와 연동된 이력이 존재하면 자신의 평균 내신 점수를 확인할 수 있습니다.

4. Technology Stack (기술 스택)

4.1 Language

HTML5
CSS3
Typescript

4.2 Frotend

React		18.0.0
NextJs		14.2.5
TailwindCSS		3.4.1

4.3 Backend

Firebase		10.12.5
NextJs		14.2.5
Redis		7.0

4.4 CI/CD

Jenkins

5. Project Structure (프로젝트 구조)

GudeokIn/
├── public/              # 이미지, 아이콘 등 정적 에셋
├── src/
│   ├── app/             # Next.js App Router (페이지 및 레이아웃)
│   │   ├── layout.tsx   # 공통 레이아웃
│   │   ├── page.tsx     # 메인 페이지
│   │   ├── globals.css  # 전역 스타일
│   │   ├── api/         # API 라우트 핸들러
│   │   ├── components/  # 재사용 UI 컴포넌트
│   │   ├── lib/         # 공통 모듈 (DB, 인증 등)
│   │   └── ... (각 기능별 페이지 폴더)
│   └── fonts/           # 프로젝트 사용 폰트
├── pages/
│   └── api/             # Next.js API 라우트
├── next.config.mjs      # Next.js 설정 파일
├── tailwind.config.ts   # Tailwind CSS 설정 파일
├── tsconfig.json        # TypeScript 설정 파일
└── package.json         # 프로젝트 의존성 및 스크립트