개발¶

Wagtail 코드베이스 설정하기¶

올바른 버전의 Node를 설치하는 가장 좋은 방법은 Fast Node Manager (fnm)를 사용하는 것입니다. fnm은 프로젝트 루트의\ .nvmrc\ 파일에 명시된 버전과 항상 일치시켜 줍니다. 올바른 버전의 Node를 실행하고 있는지 확인하려면 프로젝트 루트에서\ fnm install\ 을 실행하세요. 또는 Node.js를 직접 설치할 수도 있습니다. 이 경우 프로젝트 루트의\ .nvmrc\ 파일에 선언된 버전을 설치해야 합니다.

아직 설치하지 않았다면 libjpeg 와 zlib 라이브러리도 설치해야 합니다 - Pillow의 플랫폼별 설치 지침을 참조하세요.

Wagtail 코드베이스를 포크하고 포크한 복사본을 클론하세요:

git clone https://github.com/username/wagtail.git
cd wagtail

선호하는 virtualenv를 활성화한 상태에서, 포함된 테스트 및 문서 종속성과 함께 개발 모드로 Wagtail 패키지를 설치하세요:

pip install -e ."[testing,docs]" --config-settings editable-mode=strict -U

정적 에셋 빌드를 위한 도구 체인을 설치하세요:

npm ci

에셋을 컴파일하세요:

npm run build

이제 이 가상 환경에서 시작하는 모든 Wagtail 사이트는 이 개발용 Wagtail 인스턴스에 대해 실행됩니다. Wagtail 개발의 기반으로 Wagtail Bakery 데모 사이트를 사용하는 것을 권장합니다. Wagtail 사이트의 설정 단계에는 릴리스 버전의 Wagtail 설치가 포함될 수 있으며, 이 경우 방금 설정한 개발 버전이 재정의될 수 있다는 점을 명심하세요. 이 경우, Wagtail 사이트의 가상 환경에 로컬 Wagtail 개발 인스턴스를 설치하려면 다음을 실행하세요:

pip install -e path/to/wagtail"[testing, docs]" --config-settings editable-mode=strict -U

여기서\ path/to/wagtail\ 은 로컬 Wagtail 복사본의 경로입니다.

Windows에서 개발하기¶

Windows에서의 개발에 대한 문서는 일부 미흡한 부분이 있으며 진행 중인 작업으로 간주해야 합니다. 이미 사용 가능한 스크립트인 docker-wagtail-develop 또는 vagrant-wagtail-develop를 사용하여 로컬 가상 머신에 설정하는 것을 권장합니다.

Windows에서 Python 및 Node 개발에 자신이 있고 여기서 계속 진행하고 싶다면 몇 가지 유용한 팁이 있습니다.

Windows에서 패키지를 관리하기 위해 Chocolatey를 사용하는 것을 권장합니다. Chocolatey가 설치되면\ make\ 유틸리티를 설치하여 일반적인 빌드 및 개발 명령을 실행할 수 있습니다.

우리는 줄 끝(line ending)으로 LF를 사용합니다. 다른 운영 체제의 다른 개발자들과 효과적으로 협업하려면, Git의 자동 CRLF 처리를 사용하도록\ core.autocrlf\ 설정을\ true\ 로 설정하세요:

git config --global core.autocrlf true

테스트¶

Wagtail 코드베이스의 루트에서 다음 명령을 실행하여 모든 Python 테스트를 실행하세요:

python runtests.py

# 현재 환경에서 실행
python runtests.py wagtail

# 지정된 Tox 환경에서 실행
tox -e py39-dj32-sqlite-noelasticsearch -- wagtail

# 사용 가능한 Tox 환경 목록 보기
tox -l

# 현재 환경에서 실행
python runtests.py wagtail.tests.test_blocks.TestIntegerBlock

# 지정된 Tox 환경에서 실행
tox -e py39-dj32-sqlite-noelasticsearch -- wagtail.tests.test_blocks.TestIntegerBlock

django-admin makemigrations --settings=wagtail.test.settings

python runtests.py --postgres

DATABASE_ENGINE=django.db.backends.mysql python runtests.py

python runtests.py --elasticsearch8

ELASTICSEARCH_URL=https://my-elasticsearch-instance:9200 python runtests.py --elasticsearch8

npm run test:unit

export DJANGO_SETTINGS_MODULE=wagtail.test.settings_ui
# 현재 환경에 로컬 개발용 Wagtail이 유효하게 설치되어 있다고 가정합니다.
./wagtail/test/manage.py migrate
./wagtail/test/manage.py createcachetable
DJANGO_SUPERUSER_EMAIL=admin@example.com DJANGO_SUPERUSER_USERNAME=admin DJANGO_SUPERUSER_PASSWORD=changeme ./wagtail/test/manage.py createsuperuser --noinput
./wagtail/test/manage.py runserver 0:8000
# 별도의 터미널에서:
npm --prefix client/tests/integration install
npm run test:integration

정적 에셋 컴파일하기¶

Wagtail 관리자용 JavaScript, CSS, 이미지, 폰트와 같은 모든 정적 에셋은 Webpack에 의해 각 소스로부터 컴파일됩니다. 컴파일된 에셋은 저장소에 커밋되지 않으며, 각 새 릴리스를 패키징하기 전에 컴파일됩니다. 컴파일된 에셋은 풀 리퀘스트의 일부로 제출되어서는 안 됩니다.

에셋을 컴파일하려면 다음을 실행하세요:

npm run build

이 작업은 소스 파일을 변경할 때마다 수행해야 합니다. 소스 파일의 변경 사항을 감시하고 자동으로 에셋을 다시 컴파일하려면 다음을 실행하세요:

npm start

패턴 라이브러리 사용하기¶

Wagtail의 UI 컴포넌트 라이브러리는 Storybook과 django-pattern-library로 구축되었습니다. 로컬에서 실행하려면,

export DJANGO_SETTINGS_MODULE=wagtail.test.settings_ui
# 현재 환경에 로컬 개발용 Wagtail이 유효하게 설치되어 있다고 가정합니다.
./wagtail/test/manage.py migrate
./wagtail/test/manage.py createcachetable
./wagtail/test/manage.py runserver 0:8000
# 별도의 터미널에서:
npm run storybook

마지막 명령은\ http://localhost:6006/\ 에서 Storybook을 시작합니다. 기본적으로 특정 요청을\ http://localhost:8000\ 의 Django로 프록시합니다. Django에 다른 포트를 사용하려면\ TEST_ORIGIN\ 환경 변수를 사용하세요:\ TEST_ORIGIN=http://localhost:9000 npm run storybook\ .

문서 컴파일하기¶

Wagtail 문서는 Sphinx로 빌드됩니다. Sphinx를 설치하고 문서를 컴파일하려면 다음을 실행하세요:

# wagtail 루트 디렉토리에서 시작:

# 문서 종속성 설치
pip install -e .[docs] --config-settings editable-mode=strict
# 또는 zsh 셸을 사용하는 경우:
#    pip install -e '.[docs]' -U
# 문서 컴파일
cd docs/
make html

컴파일된 문서는 이제\ docs/_build/html\ 에 있습니다. 웹 브라우저에서 이 디렉토리를 열어 확인하세요. Python에는 웹 브라우저에서 정적 파일을 매우 쉽게 미리 볼 수 있는 모듈이 함께 제공됩니다. 이 간단한 서버를 시작하려면 다음 명령을 실행하세요:

# wagtail 루트 디렉토리에서 시작:

cd docs/_build/html/
python -m http.server 8080

이제 웹 브라우저에서 http://localhost:8080/을 열어 컴파일된 문서를 볼 수 있습니다.

Sphinx는 후속 컴파일 속도를 높이기 위해 빌드된 문서를 캐시합니다. 불행히도 이 캐시는 수정되지 않은 문서 소스 파일에서 발생하는 모든 경고를 숨깁니다. 빌드된 HTML을 지우고 새로 시작하여 문서 빌드 시 발생하는 모든 경고를 보려면 다음을 실행하세요:

# wagtail 루트 디렉토리에서 시작:

cd docs/
make clean
make html

Wagtail은 또한 각 변경 시마다 문서가 자동으로 컴파일되는 방법을 제공합니다. 이를 위해 다음 명령을 실행하여\ localhost:4000\ 에서 변경 사항을 자동으로 확인할 수 있습니다:

# wagtail 루트 디렉토리에서 시작:

cd docs/
make livehtml

커밋 시 자동으로 린트 및 코드 형식 지정하기¶

pre-commit은 모든 커밋과 함께 코드 린팅 및 형식 지정 검사를 자동으로 실행하도록 구성되어 있습니다. pre-commit을 git hook에 설치하려면 다음을 실행하세요:

pre-commit install

이제 pre-commit은 여러분이 만드는 모든 커밋에 대해 실행됩니다.

설치에 포크 사용하기¶

때로는 포크에서 Wagtail을 설치해야 할 수도 있습니다. 예를 들어, 여러분의 사이트가 현재 리뷰 대기 중인 버그 수정에 의존하고 있는데 새로운 릴리스를 기다릴 여유가 없는 경우입니다.

Wagtail 릴리스 프로세스에는 정적 에셋 빌드 및 번역 업데이트 단계가 포함되어 있어, 요구사항 파일을 메인 저장소의 특정 git 커밋을 가리키도록 업데이트할 수 없습니다.

포크에서 설치하려면, `build`\ (python -m pip install build)\ 와 정적 에셋 빌드용 도구(npm install)\ 를 설치했는지 확인하세요. 그런 다음, Wagtail git 체크아웃의 루트에서 다음을 실행하세요:

python -m build

이렇게 하면\ dist/\ 내에\ .tar.gz\ 및\ .whl\ 패키지가 생성되며, 이를\ pip\ 로 설치할 수 있습니다.

원격 배포의 경우, 일반적으로 이를 공개 URL에 업로드하고 프로젝트의 요구사항 파일에서 표준\ wagtail\ 라인 대신 해당 URL을 배치하는 것이 가장 편리합니다.