위의 해당 코드들을 추가한 후 파일을 저장하고 터미널에서 npm run deploy 커맨드를 실행해줍니다. 그리고 github repository에서 해당 repository page 설정을 해주신 후 나타나는 주소로 접속하면 React Project가 배포된 것을 확인 할 수 있습니다.!!! Show
혹시 프로젝트 배포 후 React Project가 아니라 README.md 파일이 나타나는 경우 아래의 사진처럼 Branch를 ‘main’이나 설정해둔 Branch명이 아니라 ‘gh-pages’로 지정해주면 정상적으로 React Project가 출력됩니다. 여러분의 사이트는 베르셀(Vercel), 깃허브 페이지(GitHub Pages), 네트리파이(Netlify), 렌더(Render), 서지(Surge) 같은 파일 호스팅 서비스로 배포할 수도 있습니다... 도큐사우루스 사이트는 정적 렌더링 방식을 사용합니다. 자바스크립트가 없이도 잘 동작합니다. 설정라우팅을 최적화하고 올바른 위치에서 파일을 제공하려면 5에 다음 매개변수가 필요합니다.옵션명설명 6사이트의 URL을 설정합니다. 사이트 배포 경로가 7이라면 6은 9입니다. 0트레일링 슬래시를 포함한 프로젝트 Base URL을 설정합니다. 사이트 배포 경로가 7이라면 0은 3입니다.로컬에서 빌드 테스트하기실제 배포 작업을 진행하기 전에 로컬에서 빌드 테스트를 진행해야 합니다. 도큐사우루스는 로컬 빌드 테스트를 위한 4 명령을 지원합니다:
기본적으로 여러분의 사이트는 http://localhost:3000/로 로드됩니다. 트레일링 슬래시 설정도큐사우루스는 URL/링크와 파일명 생성 패턴을 선택할 수 있는 5 설정을 지원합니다.기본값에서도 잘 동작합니다. 하지만 정적 호스팅 서비스 제공 업체에 따라 다른 동작 방식을 가질 수 있습니다. 때문에 같은 사이트를 여러 서비스에 배포하면 다른 결과가 나타날 수도 있습니다. 여러분이 선택한 호스팅 서비스에 따라 설정을 변경해서 사용할 수 있습니다. 팁 호스팅 서비스에서 지원하는 동작 방식과 적절한 5 설정을 위해 slorber/trailing-slash-guide 문서를 참조하세요.환경 변수 사용하기잠재적으로 민감할 수 있는 정보는 환경 설정으로 빼놓은 것이 일반적인 관행입니다. 하지만 전형적인 도큐사우루스 웹사이트에서 5 파일은 Node.js 환경 설정에 대한 유일한 인터페이스입니다(아키텍처 개요 참조). 반면에 MDX 페이지, 리액트 컴포넌트 등 다른 것들은 클라이언트 측에 있어 8에 전역으로 직접 접근할 수 없습니다. 이런 경우에는 9를 사용해 환경 변수를 클라이언트 쪽으로 전달하는 것을 고려해볼 수 있습니다.docusaurus.config.js
home.jsx
호스팅 공급자 선택하기몇 가지 공통적인 호스팅 옵션입니다.
어떤 것을 선택해야 할지 잘 모르겠다면 다음 질문을 참고하세요. 얼마나 많은 자원(인력, 돈)을 투자할 의향이 있나요?
모든 것을 만족하는 해결책은 없습니다. 선택을 하기 전에 어떤 것이 필요한지 어떤 자원을 가지고 있는지 확인하고 결정해야 합니다. 웹 서버를 구축하고 직접 호스팅하기도큐사우루스에서 4 명령을 사용해 직접 호스팅할 준비를 할 수 있습니다. 1 옵션에서 포트를 변경하고 2 옵션에서 호스트를 변경합니다.
warning 직접 호스팅하는 것은 정적 호스팅 서비스 제공 업체나 CDN과 비교해서 최선의 선택은 아닙니다. warning 다음 섹션에서는 몇 가지 대중적인 호스팅 공급자에서 도큐사우루스 사이트를 가장 효율적으로 배포하기 위한 구성 방법을 소개합니다. 일부 콘텐츠는 외부 기고자가 작성했습니다. 도큐사우루스는 어떤 서비스와도 직접 관련은 없습니다. 문서가 최신 상태가 아닐 수 있습니다. 최근 변경된 API 내용이 우리쪽에 반영되지 않을 수 있습니다. 오래된 콘텐츠를 발견했다면 언제든지 PR을 올려주세요. 최신 정보를 반영하지 못하는 문제 때문에 새로운 호스팅 공급자 구성을 추가하는 PR 접수를 중단했습니다. 하지만 별도 사이트(예를 들어 블로그 또는 호스팅 공급자 웹사이트)에 글을 게시하고 해당 콘텐츠에 대한 링크를 포함하도록 요청할 수는 있습니다. 네트리파이(Netlify)를 사용해 배포하기여러분의 도큐사우루스 2 사이트를 네트리파이(Netlify)에 배포하려면 먼저 아래와 같은 설정이 필요합니다. docusaurus.config.js
그리고나서 여러분의 사이트를 네트리파이에 만듭니다. 사이트 설정을 위해 다음과 같은 빌드 명령과 디렉터리를 지정해주세요.
사전에 빌드 옵션을 설정하지 않았더라도 사이트를 만든 이후에 "Site settings" -> "Build & deploy" 메뉴에서 설정할 수 있습니다. 위에 설명한 옵션으로 적절하게 설정했다면 여러분의 사이트를 배포할 수 있습니다. 그리고 기본적으로 5으로 설정된 배포 브랜치에 병합되면 자동으로 재배포가 진행됩니다.주의 일부 도큐사우루스 사이트는 아래와 같이 6 폴더 바깥쪽에 7 폴더를 가집니다(대부분 도큐사우루스 v1 사이트입니다)
6 폴더를 네트리파이 기본 디렉터리로 사용하는 것으로 설정하면 네트리파이는 7 폴더를 업데이트할 때 빌드 작업을 실행하지 않습니다. 그리고 아래와 같이 사용자 지정 0 명령을 설정해주어야 합니다.website/netlify.toml 0warning 기본적으로 네트리파이는 트레일링 슬래시를 도큐사우루스 URL에 추가합니다. URL 소문자 변환, 원하지 않는 리다이렉트, 404 에러를 방지하기 위해 네트리파이에서 1 설정을 비활성화 체크해주는 것을 권장합니다.정말 주의하세요: 2 전역 체크 기능은 잘 동작하지 않습니다. 해당 항목을 체크해도 3 설정이 비활성화되지는 않습니다. 각 항목을 개별적으로 체크해주세요.네트리파이에서 4 설정을 활성화하고 싶다면 도큐사우루스에서 5 설정을 그에 맞게 조정해주어야 합니다.좀 더 자세한 정보는 slorber/trailing-slash-guide를 참고하세요. 베르셀(Vercel)을 사용해 배포하기도큐사우루스 프로젝트를 베르셀(Vercel)에 배포하면 성능과 사용 편의성 측면에서 몇 가지 이점이 제공됩니다. 베르셀 깃 통합 기능을 사용해 도큐사우루스 프로젝트를 배포하기 위해서는 깃 저장소에 제대로 업로드되었는지 확인합니다. 베르셀의 가져오기 기능을 이용해 프로젝트를 가져옵니다. 가져오기 시 미리 설정된 관련 옵션을 확인할 수 있습니다. 모든 옵션은 변경할 수 있으며 목록은 베르셀 가이드 문서에서 확인할 수 있습니다. 프로젝트를 가져온 후 브랜치로 보내지는 모든 작업에 대해 미리보기 배포가 만들어집니다. 그리고 제품 브랜치(보통 "main" 또는 "master")에 변경이 생기면 제품 배포가 진행됩니다. 깃허브 페이지(GitHub Pages)를 사용해 배포하기도큐사우루스는 모든 깃허브 저장소와 함께 무료로 사용할 수 있는 깃허브 페이지에 배포하는 쉬운 방법을 제공합니다. 개요일반적으로 배포 프로세스와 관련된 두 개의 저장소(최소한 두 개 브랜치)가 있습니다. 소스 파일을 포함하고 있는 브랜치와 깃허브 페이지에 제공될 빌드 결과물이 포함된 브랜치입니다. 이 글에서는 각각 소스와 배포라고 하겠습니다. 각각의 깃허브 저장소는 깃허브 페이지 서비스와 연결됩니다. 배포 저장소가 6 (여기서 7는 조직 또는 사용자 이름입니다)인 경우 배포된 사이트는 8가 됩니다. 특히 배포 저장소가 9 (그룹 계정 깃허브 페이지 저장소인 경우 사이트는 0가 됩니다.정보 깃허브 페이지에 여러분이 가지고 있는 도메인을 연결하기 원한다면 1 디렉터리 안에 2 파일을 만들어줍니다. 1 디렉터리 아래 있는 파일은 모두 배포 시 3 디렉터리 아래로 복사됩니다. 사용자 정의 도메인을 사용한다면 5에서 6로 돌아갈 수 있어야 하며 6을 여러분의 사용자 정의 도메인으로 설정해야 합니다.좀 더 자세한 내용은 깃허브 페이지 가이드 문서를 참고하세요. 깃허브 페이지는 기본 브랜치(일반적으로 8 / 5) 또는 0 브랜치 그리고 루트 폴더 또는 1 폴더에서 배포 대상 파일( 2에서 만든)을 가져옵니다. 저장소 3에서 필요한 항목을 설정할 수 있습니다. 이 브랜치를 "배포 브랜치"라고 합니다.하나의 명령으로 소스 브랜치에서 배포 브랜치로 사이트를 배포할 수 있게 4 명령인 clone, build, commit을 제공합니다.yarn run serve5 파일 설정하기먼저 5 파일에서 필요한 몇 가지 항목을 추가해주어야 합니다.옵션명설명 7배포 저장소를 소유하고 있는 깃허브 사용자 또는 그룹 계정을 설정합니다. 8배포 저장소 이름을 설정합니다. 9배포 브랜치 이름을 설정합니다. 그룹 계정이 아니라면 깃허브 페이지 저장소 기본값은 0 입니다( 8이 2로 끝나지 않습니다). 아니면 구성 필드 또는 환경 변수를 사용해 명시적으로 지정해야 합니다.이런 필드에 대응하는 환경 변수 중에 더 높은 우선 순위를 가지고 있는 경우도 있습니다. 예를 들면 3, 4, 5.주의 깃헙 페이지는 도큐사우루스 URL에 트레일링 슬래시를 기본적으로 추가합니다. 5 설정은 ( 7 또는 8, 9는 제외) 값으로 설정하는 것을 권장합니다.예: docusaurus.config.js 1warning 기본적으로 깃허브 페이지는 지킬을 통해 게시된 파일을 실행합니다. 지킬은 00로 시작하는 모든 파일을 삭제합니다. 때문에 1 디렉터리에 02라는 이름을 가진 빈 파일을 추가해 지킬을 비활성화하는 것을 권장합니다.환경 설정옵션명설명 03깃허브 저장소에 연결 시 기본 HTTPS 대신 SSH를 사용하려면 7로 설정합니다. 소스 저장소 URL이 SSH URL(예 05)인 경우 03 값이 7로 추측할 수 있습니다. 08배포 저장소에 push 권한을 가지고 있는 깃허브 계정 사용자 이름입니다. 여러분이 소유자인 저장소라면 사용하고 있는 깃허브 사용자명을 설정합니다. SSH를 사용하지 않는다면 필수이며 그렇지 않은 경우에는 무시됩니다. 09비대화형 배포(예 지속적인 배포)를 용이하게 하기 위한 깃허브 사용자(특히 08)의 개인 액세스 토큰 11소스 브랜치. 일반적으로 브랜치는 5 또는 8입니다. 하지만 0을 제외한 어떤 브랜치든지 가능합니다. 이 변수를 설정하지 않으면 4가 호출되는 현재 브랜치가 사용됩니다.깃허브 엔터프라이즈를 사용하는 경우에도 깃허브와 다르지 않습니다. 환경 변수에 깃허브 엔터프라이즈에서 사용하는 그룹 계정을 설정해주기만 하면 됩니다. 옵션명설명 16깃허브 엔터프라이즈 사이트에서 사용하는 도메인 이름을 설정합니다. 17깃허브 엔터프라이즈 사이트에서 사용하는 포트를 설정합니다.배포이제 아래 명령을 사용해 여러분의 사이트를 깃허브 페이지로 배포합니다.
2 3 4주의 2021년 8월부터 깃허브에서는 암호 대신 개인 액세스 토큰을 사용하기 위해 모두에게 명령줄 로그인을 요구합니다. 깃허브에서 암호를 묻는 메시지가 표시되면 PAT를 대신 입력하세요. 좀 더 자세한 내용은 깃허브 문서를 참고하세요. 그렇지 않으면 SSH ( 18)를 사용해 로그인할 수 있습니다.깃허브 액션(GitHub Actions)을 사용해 자동으로 배포하기깃허브 액션은 여러분의 저장소에서 소프트웨어 배포를 자동으로 원하는 형태로 실행할 수 있도록 지원합니다. 예제 워크플로우에서는 여러분의 웹사이트 소스는 저장소 5 브랜치(소스 브랜치가 5) 에 있고 게시할 소스는 0 브랜치(배포 브랜치가 0) 에 있다고 가정합니다.우리의 목표는 다음과 같습니다.
다음은 깃허브 액션을 사용해 문서를 배포하는 두 가지 접근 방식입니다. 배포 브랜치( 0)의 위치에 따라 아래에서 관련 탭을 선택합니다.
같은 워크플로 파일에 두 가지 작업을 모두 정의할 수 있지만 원래의 28 워크플로는 항상 PR 체크 스위트 상태에서 건너뛴 것으로 처리되며 실제 상태를 전달하지 않기 때문에 리뷰 프로세스에 값을 제공하지 않습니다. 따라서 대신 별도의 워크플로로 관리할 것을 제안합니다.우리는 널리 사용되는 서드파티 배포 액션인 peaceiris/actions-gh-pages을 사용할 겁니다. 깃허브 액션 파일다음 두 개의 워크플로 파일을 추가합니다. 설정에 대한 파라미터 조정 이 파일 설정은 Yarn을 사용하고 있다고 전제합니다. npm을 사용하는 경우에는 31, 32, 33을 34, 35, 3로 적절하게 변경합니다.도큐사우루스 프로젝트가 저장소 루트에 없다면 기본 작업 디렉터리를 구성해야 할 수도 있습니다. 그에 따라 경로를 조정하세요. .github/workflows/deploy.yml 5.github/workflows/test-deploy.yml 6교차 저장소 배포는 권한 확인을 통해 다른 저장소에 푸시해야 하므로 설정하기가 더 어렵습니다. 예제에서는 SSH 인증을 사용합니다.
warning 아래 예에서 44 이메일은 여러분의 깃허브 계정으로 45 항목은 여러분의 이름으로 변경해주어야 합니다.이 파일 설정은 Yarn을 사용하고 있다고 전제합니다. npm을 사용하는 경우에는 31, 32, 33을 34, 35, 3로 적절하게 변경합니다..github/workflows/deploy.yml 7사이트가 제대로 배포되지 않았나요? main으로 푸시한 후 원하는 위치에 사이트가 표시되지 않으면(예를 들어 "There isn't a GitHub Pages site here"라고 표시되거나 저장소의 README.md 파일이 표시됨) 다음 항목을 체크합니다.
트래비스 CI(Travis CI)를 사용해 자동으로 배포하기지속적인 통합(CI) 서비스는 저장소에 새로운 커밋이 발생할때마다 반복적으로 발생하는 작업을 처리하기 위해 사용합니다. 지속적인 통합 환경에서는 단위 테스트, 통합 테스트, 자동 빌드, npm 배포, 변경된 내용을 웹 사이트에 배포하기 같은 복합적인 작업을 처리할 수 있습니다. 자동으로 웹 사이트 업데이트를 처리하기 위해서는 웹 사이트가 변경됐을때 55 스크립트를 호출하기만 하면 됩니다. 지속적인 통합 환경으로 많이 사용하고 있는 트래비스 CI에서 어떻게 도큐사우르스를 배포할 수 있는지 살펴보겠습니다.
.travis.yml 8이제 5 브랜치에 새로운 커밋이 발생하면 트래비스 CI는 테스트 스위트를 실행하고 모든 테스트가 통과되면 55 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.Buddy를 사용해 자동으로 배포하기Buddy는 깃헙 페이지를 포함한 다양한 환경에 여러분의 사이트 배포를 손쉽게 자동화할 수 있는 CI/CD 도구입니다. 아래 단계에 따라 프로젝트의 선택한 브랜치에 대한 변경 사항을 푸시할 때마다 웹 사이트의 새로운 버전을 자동으로 배포하는 파이브 라인을 만듭니다.
9간단하게 파이프 라인을 만든 후 선택한 브랜치에 푸시된 각 새로운 커밋은 55 명령을 사용해 웹 사이트를 깃헙 페이지에 배포합니다. 도큐사우루스에 맞춘 CI/CD 파이프 라인 설정에 대한 좀 더 자세한 내용은 가이드 문서를 참고하세요.애저 파이프라인(Azure Pipeline) 사용하기
azure-pipelines.yml 0드론 CI(Drone CI) 사용하기
.drone.yml 1이제 깃허브에 새로운 태그가 들어오면 여러분의 웹 사이트를 배포하기 위한 드론 CI 동작이 자동으로 시작됩니다. Koyeb를 사용해 배포하기Koyeb는 어디에나 앱을 배포할 수 있는 개발자 친화적인 서버리스 플랫폼입니다. 플랫폼을 사용하면 깃 기반 배포, 오토스케일링, 글로벌 엣지 네트워크, 기본 제공하는 서비스 메시와 서비스 디스커버리를 통해 도커 컨테이너, 웹 앱, API를 원활하게 실행할 수 있습니다. 기본적인 사용법은 Koyeb's Docusaurus deployment guide를 참고하세요. 렌더(Render)를 사용해 배포하기렌더(Render)는 무료 사이트 호스팅 서비스를 제공합니다. SSL, 커스텀 도메인, 글로벌 CDN, 깃 저장소와 연동한 지속적인 자동 배포를 지원합니다. 렌더에서 도큐사우루스 배포하기 가이드를 참고하면 빠르게 시작해볼 수 있습니다. Qovery를 사용해 배포하기Qovery는 여러분의 AWS, GCP, Azure, Digital Ocean, Scaleway 같은 여러 계정에서 동작하고 있는 정적 사이트, 백엔드 API, 데이터베이스, 크론잡, 기타 앱을 한 곳에서 관리할 수 있는 완전 관리형 클라우드 플랫폼입니다.
이게 다예요! 상태를 확인하면서 앱이 배포될 때까지 기다립니다. 브라우저에서 애플리케이션을 열려면 애플리케이션 개요에서 Action과 Open을 클릭합니다. Hostman을 사용해 배포하기Hostman은 정적 웹 사이트에 대한 무료 호스팅을 제공합니다. Hostman은 모든 것을 자동화로 지원합니다. 여러분은 저장소를 연결하고 간단한 단계를 따라오기만 하면 됩니다.
서지(Surge)를 사용해 배포하기서지(Surge)는 웹 호스팅 플랫폼입니다. 명령행 도구를 사용해 간단하게 도큐사우루스 프로젝트를 배포할 수 있습니다. 여러분의 프로젝트를 서지에 배포하는 것은 쉽고 무료(커스텀 도메인과 SSL을 포함해)입니다. 다음 단계를 따라가면 서지를 사용한 앱 배포를 쉽게 할 수 있습니다.
서지를 처음 사용한다면 명령행에 계정을 만들라는 메시지가 표시됩니다(처음 한 번만 표시됩니다) 사이트가 3 디렉터리에 게시되면 84이 무작위로 만들어집니다(서브도메인은 수정할 수 있습니다).가지고 있는 도메인 사용하기가지고 있는 도메인이 있다면 서지를 사용해 배포 시 명령에 도메인을 추가할 수 있습니다. 9여러분의 사이트는 선택에 따라 무료로 제공되는 85 또는 86에서 운영할 수 있습니다.CNAME 파일 설정하기다음 명령을 사용해 도메인을 CNAME 파일에 설정할 수 있습니다. 0 87 명령을 사용해 이후 변경 사항 발생 시 배포를 진행할 수 있습니다.퀀트CDN(QuantCDN)을 사용해 배포하기
퀀트CDN을 사용한 배포 예제와 사용 사례는 가이드 문서와 블로그를 참고하세요. Layer0을 사용해 배포하기Layer0는 여러분의 헤드리스 프론트엔드를 개발, 배포, 검토, 실험, 모니터링, 실행할 수 있는 올인원 플랫폼입니다. EdgeJS(자바스크립트 기반 콘텐츠 전송 네트워크), 예측 프리페칭, 성능 모니터링을 통한 규모 있는 동적 웹사이트와 뛰어난 수준의 성능에 중점을 둡니다. Layer0은 무료 옵션을 제공합니다. Layer0에서 도큐사우루스 배포하기 가이드를 참고하면 빠르게 시작해볼 수 있습니다. Cloudflare Pages를 사용해 배포하기Cloudflare Pages는 프론트엔드 개발자가 웹사이트를 협업을 통해 작업하고 배포할 수 있는 잼스택 플랫폼입니다. 가이드 문서를 따라 몇 분 안에 시작할 수 있습니다. 애저 Static Web Apps를 사용해 배포하기애저 Static Web Apps은 코드 저장소로부터 풀스택 웹 앱을 가져와 애저에서 자동으로 빌드하고 배포해 CI/CD에 대한 개발자 환경을 단순화하는 서비스입니다. Static Web Apps는 웹 애플리케이션의 정적 애셋을 동적(API) 엔드포인트와 분리합니다. 정적 애셋은 전 세계에 분산도니 콘텐츠 서버에서 제공되므로 클라이언트와 가까이 있는 서버를 사용해 파일을 더 빠르게 가져올 수 있습니다. 동적 API는 보다 비용 효율적이고 필요에 따라 확장되는 이벤트, 기능 기반 접근 방식을 사용해 서버리스 아키텍처로 확장됩니다. 단계별 가이드를 따락 몇 분 안에 시작할 수 있습니다. |