Project

General

Profile

Feature #1249

Updated by 성용 양 14 days ago

## 목적 

 다른 두 사람이 2주차부터 같은 파일을 건드리지 않고 작업할 수 있도록, 프로젝트 골격과 앱 스텁을 한 번에 만들고 인계합니다. 

 ## 쉬운 설명 

 모든 팀원이 같은 뼈대 위에서 일하도록 Django 프로젝트와 앱 폴더(내용은 비어 있는 껍데기)를 만듭니다. 이 일감이 끝나야 다른 사람이 자기 앱을 시작할 수 있습니다. 

 ## 기술 스택 

 Python 3.12, venv, Django 5.2 LTS, PostgreSQL 16, psycopg[binary], python-dotenv, ruff, pytest(후보). 

 ## 예상 결과(산출물) 

 모두가 clone 후 `runserver`를 띄울 수 있는 저장소. 앱 14개 + core 스텁이 settings에 등록된 상태. 

 ## 개발 작업 상세 

 1. 저장소(university-academic-system)의 기존 파일을 먼저 확인한다(기존 manage.py가 있으면 덮어쓰지 않는다). 
 2. `django-admin startproject config .`로 골격을 만들고 settings를 base/local/production으로 나눈다. 
 3. `.env.example`(비밀값 없음)을 만들고 settings가 환경변수를 읽게 한다. `.gitignore`에 `.env*`를 넣는다. 
 4. 앱 스텁을 만든다: accounts, security, academics, admissions, students, enrollment, grades, tuition, graduation, documents, files, imports, search, legacy_migration, core. INSTALLED_APPS에 한 번에 등록한다. 
 5. accounts에 커스텀 User 모델 stub(AbstractUser 기반)을 첫 migrate 전에 만든다. AUTH_USER_MODEL을 지정한다. 
 6. 로컬 PostgreSQL 16 연결, `check`·`migrate`·`runserver`를 확인한다. 
 7. ruff·pytest 설정 파일과 requirements를 만든다. 

 ## 완료 기준 

 - `python manage.py check`와 `migrate`가 통과한다. 
 - 14개 앱이 import 오류 없이 로드된다. 
 - 비밀값이 저장소에 없다. 

 ## 충돌 방지(소유 범위) 

 config/, core/, requirements, .env.example는 우섭 소유. 앱 스텁 폴더는 생성만 하고 이후 각 소유자에게 인계합니다. 이후 앱 추가 때 settings를 고치지 않아도 되도록 이 일감에서 일괄 등록합니다. 

 ## 선행·후행·위험 

 선행: 없음 (바로 시작 가능) 

 후행: 01-02 ERD·모델 계약 초안(앱 간 FK 규칙)(우섭) / 01-03 파일 소유권·브랜치·PR 규칙 문서(CODEOWNERS)(우섭) / 01-04 공통 모델·기본 템플릿·레이아웃(우섭) / 03-01 승인 계정 ID/PW 로그인·세션·로그인 제한(서현) / 04-02 GitHub Actions CI(테스트·린트·마이그레이션 검사)(성용) / 03-01(accounts User 모델), 02-02, 05-01 조직 구조(단과대학·학과·전공·학위과정) 모델·관리 화면(우섭) 

 등 모든 개발 일감. 위험: 이 일감이 밀리면 2주차 작업 전체가 밀림. 

 ## 결과 확인 방법 

 새로 받은 PC에서 README 순서만 따라 서버가 실행되고 첫 화면이 열리며 pytest가 통과하면 완료입니다. 

 ## 시작 전 준비 

 1. 선행 일감의 결과물(문서·코드)을 먼저 읽고 약속된 이름·구조를 확인한다. 
 2. 저장소를 최신으로 맞춘다: git switch main 후 git pull 
 3. 저장소 README(01-01 결과) 순서대로 환경을 준비한다. 보통 python -m venv .venv, 가상환경 켜기, pip install -r requirements.txt, docker compose up -d db(DB 실행), python manage.py migrate 순서이다. 
 4. #1226의 폴더 소유 표에서 내가 고칠 수 있는 폴더를 확인한다. 

 ## 작업 진행 순서 

 1. 브랜치를 만든다: git switch -c feature/MDGU-번호-짧은이름 
 2. "개발 작업 상세"의 번호 순서대로 한 단계씩 구현하고, 단계마다 pytest로 확인한다. 
 3. 모델을 바꾸면 python manage.py makemigrations, 그다음 python manage.py migrate를 실행한다. 
 4. 화면은 python manage.py runserver로 실행해 직접 열어 보고 "완료 기준"과 하나씩 대조한다. 
 5. git add, git commit, git push 후 PR을 만든다. PR 템플릿의 체크리스트를 채우고 폴더 소유자의 리뷰를 받는다. 
 6. 병합 후 이 일감 메모에 PR 링크와 확인 결과를 적고 상태와 진행률을 갱신한다. 

 ## 막힐 때 확인 

 패키지 설치 오류는 Python 3.12 사용 여부와 가상환경 재생성을 먼저 확인하세요. DB 연결 오류는 PostgreSQL 컨테이너가 켜져 있는지 확인하세요. 

 그래도 해결되지 않으면 일감 메모에 "무엇을 했고, 어떤 오류가 났는지"를 붙여 담당 분류 소유자 또는 팀장에게 질문하세요. 

 ## 용어 풀이 

 - **마이그레이션**: 모델(코드)의 변경을 DB 구조에 반영하는 변경 기록 파일과 그 적용 작업입니다. makemigrations로 만들고 migrate로 적용합니다. 
 - **pytest**: Python 코드를 자동으로 검사해 주는 테스트 도구입니다. 테스트 파일은 tests/ 폴더에 둡니다.

Back