JEduTools Docs

시작하기

1. 로컬 개발 환경 설정

1.1. 사전 요구사항

  • Node.js (LTS 버전 권장)
  • Yarn (패키지 매니저)

1.2. 프로젝트 Fork 및 로컬에 복제(Clone)

외부 기여자는 먼저 원본 프로젝트를 자신의 GitHub 계정으로 'Fork'해야 합니다. Fork는 다른 사람의 프로젝트를 내 저장소로 복사하여 자유롭게 수정할 수 있게 해주는 기능입니다.

Fork를 통해, 원본 레포지토리를 내 레포지토리로 복사합니다. 작업 시작

Fork가 완료되면, 내 계정에 생성된 저장소를 로컬 컴퓨터로 복제(Clone)합니다.

# [Your-GitHub-ID] 부분에 자신의 깃허브 아이디를 입력하세요.
git clone https://github.com/[Your-GitHub-ID]/JHelper.git
cd JHelper

1.3. 의존성 설치

프로젝트에 필요한 모든 의존성을 설치합니다.

yarn install

첫 설치 시, 시스템 사양에 따라 시간이 다소 소요될 수 있습니다.

1.4. 캐시 정리

문서 변경사항이 제대로 반영되지 않거나 빌드 오류가 발생할 경우, 다음 명령어로 Gatsby 캐시를 정리할 수 있습니다.

yarn clean
yarn build

1.5. 개발 서버 실행

로컬 개발 서버를 실행하여 변경사항을 실시간으로 확인합니다.

yarn develop

개발 서버가 실행되면 일반적으로 http://localhost:8000에서 문서를 확인할 수 있습니다.

메인페이지

2. (선택) Github Codespace 개발환경 구성

일부 로컬 환경에서는 개발환경이 구성되지 않는 경우가 있습니다. 이때 codespace를 활용하여 ubuntu환경을 생성하고 원격으로 작업을 수행할 수 있습니다.

2.1) JHelper 저장소를 포크하여 개인 저장소로 복제합니다.

codespace 1

2.2) 아래의 사진과 같이 codespace를 생성하면 웹 기반의 Visual Studio Code 환경에 자동으로 접속됩니다.

codespace 2

2.3) 모듈 설치 및 기여에 관한 부분은 컨트리뷰션 예시을 참고하여 수행할 수 있습니다. 매뉴얼에 따라 작업을 저장하고 PR을 생성하면 관리자가 반영할 것 입니다.

미리보기 확인시 codespace는 원격 개발환경이므로 localhost로 접속할 수 없음에 유의해야합니다. 아래의 포트 패널에서 8000 포트의 주소를 확인하여 미리보기 페이지로 접속할 수 있습니다.

codespace 3

2.4) 개인계정에 할당된 codespace는 월별 사용량이 정해져 있으므로 작업을 완료한 이후에는 다음과 같이 codespace를 삭제합니다.

codespace 4