插件窝 干货文章 部署 React 应用程序:GitHub 页面使用指南

部署 React 应用程序:GitHub 页面使用指南

部署 github 应用程序 react 829    来源:    2024-10-23

许多开发者发现部署react应用程序很困难,尤其是那些不熟悉生态系统的开发者。您可以使用 github pages 免费轻松托管静态网页,包括 react 应用程序。借助这个详细的教程,将您的 react 应用程序部署到 github pages 将变得轻松无忧,该教程将引导您完成该过程的每一步。

  1. github pages 简介

github pages 是一项静态站点托管服务,旨在直接从 github 存储库托管您的个人、组织或项目页面。它提供与 github 工作流程的无缝集成,使其成为托管 react 应用程序的理想选择。

主要优点:

免费且易于使用。

支持自定义域。

自动构建和部署您的网站。

有关更多信息,请查看 github pages 文档。

  1. 设置你的 react 应用程序

在将 react 应用程序部署到 github pages 之前,请确保您有一个可用的 react 应用程序。如果您还没有,您可以使用 create react app (cra) 创建一个新的 react 应用程序。

npx create-react-app my-react-app
cd my-react-app

此命令使用所有必要的配置设置一个新的 react 项目。

  1. 准备部署您的 react 应用程序

要将 react 应用程序部署到 github pages,您需要对应用程序的配置进行一些修改。

安装 github pages 包:

npm install gh-pages --save-dev

更新package.json:

将以下字段添加到您的 package.json 文件中:

"homepage": "https://<username>.github.io/<repository-name>",
"scripts": {
  "predeploy": "npm run build",
  "deploy": "gh-pages -d build"
}
</repository-name></username>

替换为您的 github 用户名和存储库的名称。

  1. 创建 github 存储库

转到 github 并创建一个新的存储库。

命名您的存储库并将其设置为公开。

不要使用 readme、.gitignore 或许可证进行初始化,因为这些将在稍后添加。

  1. 将你的 react 应用程序部署到 github pages

现在您的 react 应用程序已准备就绪并且您拥有 github 存储库,是时候进行部署了。

初始化git并推送到github:

git init
git remote add origin https://github.com/<username>/<repository-name>.git
git add .
git commit -m "initial commit"
git push -u origin master
</repository-name></username>

部署您的应用程序:

npm run deploy

此命令将构建您的应用程序并将其部署到存储库的 gh-pages 分支。

  1. 常见部署问题和故障排除

将 react 应用程序部署到 github pages 有时会遇到问题。以下是常见问题及其解决方案:

404错误:确保package.json中的主页字段设置正确。

构建失败:检查您的构建脚本并确保安装了所有依赖项。

cors 问题:如果您发出跨域请求,请确保您的 api 端点支持 cors。

更多故障排除技巧,请参阅 github pages 故障排除指南。

  1. 使用 github actions 自动化部署

github actions 提供了强大的 ci/cd 功能,可以自动化您的部署过程。设置方法如下:

创建工作流程文件:

在您的存储库中,创建一个名为 .github/workflows/deploy.yml 的文件。

添加部署脚本:

名称:将 react 应用部署到 github pages

on:
  push:
    branches:
      - master

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Set up Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14'

      - name: Install dependencies
        run: npm install

      - name: Build the React app
        run: npm run build

      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./build

每当您将更改推送到主分支时,此工作流程都会自动部署您的 react 应用程序。

  1. 高级部署技术

除了基础知识之外,您还可以使用多种高级技术来增强部署过程:

自定义域:您可以通过将 cname 文件添加到存储库来在 github pages 站点中使用自定义域。

https 强制执行:通过在存储库设置中启用 https 选项,确保您的网站始终通过 https 提供服务。

分支部署:从不同分支进行部署以用于临时和生产环境。

有关详细信息,请参阅 github pages 自定义域指南。

  1. 部署 react 应用程序的最佳实践

为了确保成功部署和高质量的用户体验,请遵循以下最佳实践:

优化您的构建:使用 webpack 和 babel 等工具来优化您的 javascript 包。

使用环境变量:使用环境变量管理特定于环境的设置。

监控性能:使用性能监控工具来跟踪和提高已部署应用程序的性能。

更多最佳实践,请参考 react 部署指南。

  1. 结论

将 react 应用程序部署到 github pages 是一个简单的过程,可以大大简化静态网站的托管和管理。通过遵循本指南中概述的步骤,您可以确保顺利高效的部署过程。

通过遵循本指南,您将能够将 react 应用程序部署到 github pages,利用 github 托管功能的强大功能将您的应用程序交付给全世界。