Merge pull request #11 from Django-Wanted-Internship-3-Team/feature/i…

…ssue-001

feature: 프로젝트 설정 #1

.env.example

@@ -0,0 +1,2 @@
+SECRET_KEY='django-insecure-@z03)1f&@(m*+xbz#la#_#h&d1*83qhuk8%z%lr)qgwz3%1h@2'
+DEBUG=True

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,27 @@
+---
+name: Bug template
+about: 버그 발생 시 사용하는 템플릿입니다
+title: "버그 리포트"
+labels: "bug"
+assignees:
+
+---
+
+## 버그에 대한 설명
+버그가 무엇인지 명확하고 간결하게 설명합니다.
+
+## 재현 방법
+어떤 식으로 발생했는지 순서대로 작성해주세요:
+1. 어디를 가서 '....'
+2. 어떤 행동을 했더니 '...'
+3. 에러가 나왔다 ' ... '
+
+## 예상 동작
+발생할 것으로 예상한 사항에 대한 명확하고 간결한 설명.
+
+## 스크린샷
+해당하는 경우 스크린샷을 추가하여 문제를 설명.
+
+
+## 추가 내용
+여기에 문제에 대한 다른 내용을 추가합니다.

.github/ISSUE_TEMPLATE/issue.md

@@ -0,0 +1,28 @@
+---
+name: Issue template
+about: 이슈 작성 시 사용하는 템플릿입니다
+title: "이슈 리포트"
+labels: ""
+assignees:
+
+---
+
+##  이슈 내용
+> 이슈 내용 작성
+
+<br>
+
+##  작업 사항
+- [ ] 해당 이슈의 작업사항
+
+<br>
+
+##  관련 이슈
+- #이슈 번호
+
+<br>
+
+## 기타사항
+
+
+<br>

.github/pull_request_template.md

@@ -0,0 +1,37 @@
+## PR 체크리스트
+아래 항목을 확인해 주세요:
+
+- [ ] 커밋 메시지가 우리의 가이드라인을 따르고 있는지 확인하세요
+- [ ] 변경 사항에 대한 테스트가 추가되었는지 확인하세요 (버그 수정 / 기능 추가)
+- [ ] 문서가 추가되거나 업데이트되었는지 확인하세요 (버그 수정 / 기능 추가)
+
+## PR 유형
+이 PR은 어떤 종류의 변경을 가져오나요?
+
+<!-- 이 PR에 해당하는 것을 "x"로 표시하세요. -->
+
+- [ ] 버그 수정
+- [ ] 새로운 기능 추가
+- [ ] 코드 스타일 업데이트 (서식, 로컬 변수)
+- [ ] 리팩터링 (기능 변경 없음, API 변경 없음)
+- [ ] 빌드 관련 변경
+- [ ] CI 관련 변경
+- [ ] 문서 내용 변경
+- [ ] 애플리케이션 / 인프라 변경
+- [ ] 기타... 설명:
+
+## 현재 동작은 무엇인가요?
+<!-- 수정 중인 현재 동작을 설명하거나 관련된 이슈에 링크하세요. -->
+
+이슈 번호: N/A
+
+## 새로운 동작은 무엇인가요?
+
+## 이 PR은 호환성 변경을 도입하나요?
+
+- [ ] 예
+- [ ] 아니요
+
+<!-- 이 PR에 호환성 변경이 포함되어 있다면, 기존 응용 프로그램에 대한 영향과 마이그레이션 경로를 아래에 설명해 주세요. -->
+
+## 기타 정보

.github/workflows/CI.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [ "develop", "main" ]
+
+jobs:
+  django-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Build docker
+        run: docker compose build
+
+      - name: Migration test database
+        run: docker compose run django poetry run python src/manage.py migrate
+
+      - name: Run isort
+        run: docker compose run django poetry run isort . --check
+
+      - name: Run black
+        run: docker compose run django poetry run black . --check
+
+      - name: Run flake8
+        run: docker compose run django poetry run flake8
+
+      - name: Run Test
+        run: docker compose run django poetry run python3 src/manage.py test src

.gitmessage.txt

@@ -0,0 +1,30 @@
+################
+# <타입> : <제목> 의 형식으로 제목을 아래 공백줄에 작성
+# 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지
+# 예) :sparkles:Feat : 로그인 기능 추가 # 이슈번호
+
+# 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함)
+
+################
+# 본문(구체적인 내용)을 아랫줄에 작성
+# 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내)
+# '왜'라는 것에 초점을 맞춰 작성
+
+################
+# 꼬릿말(footer)을 아랫줄에 작성 (현재 커밋과 관련된 이슈 번호 추가 등)
+# 해결 -> Closes(종료), Fixes(수정), Resolves(해결)
+# 참고 -> Ref(참고), Related to(관련), See also(참고)
+# 예) Close #7
+
+################
+# :tada:Init: 프로젝트 개시
+# :sparkles:Feat : 새로운 기능 추가
+# :bug:Fix : 버그 수정
+# :fire:Remove : 코드 삭제
+# :memo:Docs : 문서 수정
+# :white_check_mark:Test : 테스트 코드, 리팩토링 테스트 코드 추가
+# :test_tube:Failing Test : 실패 테스트 코드
+# :recycle:Refact : 코드 리팩토링
+# :rocket:Deploy : 배포
+# :hammer:Chore : 빌드 업무 수정, 패키지 매니저 수정
+################

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/ambv/black
+    rev: 23.7.0
+    hooks:
+    - id: black
+      args: ['-l', '140', '-t', 'py311']
+
+  - repo: https://github.com/myint/autoflake
+    rev: v1.4
+    hooks:
+      - id: autoflake
+        args:
+          - --remove-all-unused-imports
+          - --remove-unused-variables
+          - --ignore-init-module-imports
+          - --in-place
+          - --recursive
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        args: ['--profile', 'black', '--filter-files', 'true']
+
+default_language_version:
+  python: python3.11

Dockerfile

@@ -0,0 +1,17 @@
+FROM python:3.11-slim
+
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+ENV POETRY_VERSION=1.6.1
+ENV PYTHONPATH=${PYTHONPATH}:${PWD}
+
+RUN mkdir /app/
+RUN mkdir /app/src/
+WORKDIR /app
+
+COPY pyproject.toml /app/
+COPY setup.cfg /app/
+
+RUN pip install poetry==${POETRY_VERSION}
+RUN poetry config virtualenvs.create false
+RUN poetry install --no-root

docker-compose.yml

@@ -0,0 +1,33 @@
+version: '3.9'
+
+volumes:
+  postgres: {}
+
+services:
+  postgres:
+    container_name: postgres
+    image: postgres:16.0-alpine
+    volumes:
+      - postgres:/var/lib/postgresql/data/
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=password
+      - POSTGRES_DB=budgets-app
+      - TZ=Asia/Seoul
+    restart: on-failure
+
+  django:
+    container_name: django
+    build:
+      context: .
+      dockerfile: Dockerfile
+    command: python src/manage.py runserver 0.0.0.0:8000
+    volumes:
+      - ./src:/app/src/
+    environment:
+      - POSTGRESQL_HOST=postgres
+    ports:
+      - "8000:8000"
+    depends_on:
+      - postgres
+    restart: on-failure