Django Enterprise Boilerplate

# 저장소 클론
git clone https://github.com/lee-lou2/django-boilerplate.git
cd django-boilerplate

# uv 설치 (미설치 시)
# macOS (Homebrew 권장):
#   brew install uv
# 기타 환경: https://docs.astral.sh/uv/getting-started/ 참고

# 의존성 동기화 (자동으로 .venv 생성)
uv sync

# 소스 폴더로 이동
cd src

# logs 폴더 생성
mkdir -p logs

# 환경 변수 설정
cp .env.example .env
# .env 파일 편집하여 데이터베이스, 이메일, S3 등 설정

# 마이그레이션 실행
uv run python manage.py migrate

# 관리자 계정 생성 (선택)
uv run python manage.py createsuperuser

# 개발 서버 실행
uv run python manage.py runserver

# 루트 디렉토리에서 실행
docker compose up -d --build

# 웹 접속: http://localhost:8000
# API 헬스체크: http://localhost:8000/_health/

django-boilerplate/
├── src/                       # 소스 폴더
│   ├── apps/                  # 앱 모듈
│   │   ├── account/           # 계정 관리
│   │   ├── agreement/         # 약관 관리
│   │   ├── benefit/           # 혜택 관리
│   │   ├── cms/               # 콘텐츠 관리
│   │   ├── device/            # 디바이스 관리
│   │   ├── feed/              # 피드 시스템
│   │   ├── file/              # 파일 관리
│   │   ├── game/              # 게임
│   │   ├── short_url/         # 숏링크 관리
│   │   └── user/              # 사용자 관리
│   ├── base/                  # 공통 모듈
│   │   ├── enums              # 열거형
│   │   ├── utils              # 공통 유틸
│   │   └── fields             # 필드 클래스
│   ├── conf/                  # 프로젝트 설정
│   │   ├── settings/          # 환경별 설정
│   │   │   ├── base.py        # 기본 설정
│   │   │   ├── local.py       # 로컬 환경
│   │   │   ├── develop.py     # 개발 환경
│   │   │   ├── stage.py       # 스테이지 환경
│   │   │   └── prod.py        # 운영 환경
│   │   ├── urls/              # URL 설정
│   │   │   ├── admin.py       # 관리자 URL 설정
│   │   │   ├── api.py         # API URL 설정
│   │   │   └── url.py         # URL Shortener 설정
│   │   ├── authentications.py # 인증 설정
│   │   ├── caches.py          # 캐시 설정
│   │   ├── celery.py          # Celery 설정
│   │   ├── exceptions.py      # 예외 처리
│   │   ├── filters.py         # 필터 설정
│   │   ├── hosts.py           # 호스트 설정
│   │   ├── routers.py         # 라우터 설정
│   │   ├── schedules.py       # 스케줄러 설정
│   │   ├── utils.py           # 공통 유틸리티 함수
│   │   └── wsgi.py            # WSGI 설정
│   ├── static/                # 정적 파일
│   ├── templates/             # 템플릿 파일
│   ├── .env.example           # 환경 변수 예제
│   ├── Makefile               # 명령어 파일
│   └── manage.py              # Django 관리 명령어
├── docs/                      # 문서
│   ├── files/                 # 파일
│   ├── ko/                    # 한국어 문서
│   └── en/                    # 영어 문서
├── docker-compose.yml         # Docker Compose 설정
├── Dockerfile                 # Docker 이미지 설정
├── pyproject.toml             # 프로젝트 설정 및 의존성 관리 (uv)
├── uv.lock                    # 의존성 잠금 파일
└── README.md                  # 프로젝트 소개

app_name/
├── v1/                        # API 버전 1
│   ├── filters.py             # 필터셋 클래스
│   ├── serializers.py         # 시리얼라이저
│   ├── views.py               # 뷰 함수/클래스
│   ├── urls.py                # URL 패턴
│   ├── utils.py               # 유틸리티 함수
│   ├── tasks.py               # 비동기 작업
│   └── tests.py               # 테스트
├── migrations/                # DB 마이그레이션
├── management/                # 관리 명령어
│   └── commands/              # 사용자 정의 명령어
├── admin.py                   # 관리자 인터페이스
├── apps.py                    # 앱 설정
├── models.py                  # 데이터 모델
└── signals.py                 # 시그널 처리

# 모든 테스트 실행
uv run python manage.py test

# 특정 앱 테스트
uv run python manage.py test apps.account

uv run python src/manage.py startapp my_app

# Makefile을 이용한 실행(권장)
make load-test

# 또는 직접 실행
uv run python -m locust -f src/tests/locust/locustfile.py \
  --headless -u 10 -r 5 -t 30s \
  --host=http://127.0.0.1:8000 \
  --html=locust_report.html