Gatsby Auth Starter with AWS Amplify 项目教程

1. 项目的目录结构及介绍

gatsby-auth-starter-aws-amplify/
├── amplify/
│   ├── # AWS Amplify 配置文件和资源
├── src/
│   ├── components/
│   │   ├── # React 组件
│   ├── pages/
│   │   ├── # Gatsby 页面组件
│   ├── templates/
│   │   ├── # Gatsby 模板组件
│   ├── utils/
│   │   ├── # 工具函数
├── static/
│   ├── # 静态资源文件
├── gatsby-config.js
├── gatsby-node.js
├── package.json
├── README.md
└── yarn.lock

目录结构介绍

• amplify/: 包含 AWS Amplify 的配置文件和资源，用于管理项目的后端服务。
• src/: 项目的源代码目录。
  • components/: 存放 React 组件。
  • pages/: 存放 Gatsby 页面组件，每个文件对应一个页面。
  • templates/: 存放 Gatsby 模板组件，用于生成动态页面。
  • utils/: 存放工具函数，用于处理通用逻辑。
• static/: 存放静态资源文件，如图片、字体等。
• gatsby-config.js: Gatsby 配置文件，用于配置站点元数据、插件等。
• gatsby-node.js: Gatsby Node API 配置文件，用于处理构建过程中的自定义逻辑。
• package.json: 项目依赖和脚本配置文件。
• README.md: 项目说明文档。
• yarn.lock: 锁定依赖版本。

2. 项目的启动文件介绍

gatsby-config.js

module.exports = {
  siteMetadata: {
    title: `Gatsby Auth Starter with AWS Amplify`,
    description: `A starter project with authentication using Gatsby & AWS Amplify.`,
    author: `@dabit3`,
  },
  plugins: [
    `gatsby-plugin-react-helmet`,
    {
      resolve: `gatsby-source-filesystem`,
      options: {
        name: `images`,
        path: `${__dirname}/src/images`,
      },
    },
    `gatsby-transformer-sharp`,
    `gatsby-plugin-sharp`,
    {
      resolve: `gatsby-plugin-manifest`,
      options: {
        name: `gatsby-starter-default`,
        short_name: `starter`,
        start_url: `/`,
        background_color: `#663399`,
        theme_color: `#663399`,
        display: `minimal-ui`,
        icon: `src/images/gatsby-icon.png`, // This path is relative to the root of the site.
      },
    },
    // this (optional) plugin enables Progressive Web App + Offline functionality
    // To learn more, visit: https://gatsby.dev/offline
    // `gatsby-plugin-offline`,
  ],
}

文件介绍

• siteMetadata: 配置站点的元数据，如标题、描述、作者等。
• plugins: 配置 Gatsby 插件，如 gatsby-plugin-react-helmet 用于 SEO，gatsby-source-filesystem 用于处理文件系统，gatsby-transformer-sharp 和 gatsby-plugin-sharp 用于图像处理，gatsby-plugin-manifest 用于 PWA 配置。

3. 项目的配置文件介绍

amplify/ 目录

amplify/
├── backend/
│   ├── auth/
│   │   ├── # 认证配置
│   ├── storage/
│   │   ├── # 存储配置
│   ├── api/
│   │   ├── # API 配置
├── team-provider-info.json
├── aws-exports.js

文件介绍

• backend/: 包含项目的后端配置，如认证、存储、API 等。
  • auth/: 认证配置，如用户注册、登录等。
  • storage/: 存储配置，如文件上传、下载等。
  • api/: API 配置，如 GraphQL API。
• team-provider-info.json: 团队提供者信息，用于多环境配置。
• aws-exports.js: AWS Amplify 配置文件，包含项目的 AWS 资源配置。

gatsby-node.js

exports.onCreatePage = async ({ page, actions }) => {
  const { createPage } = actions
  // page.matchPath is a special key that's used for matching pages
  // only on the client.
  if (page.path.match(/^\/app/)) {
    page.matchPath = "/app/*"
    // Update the page.
    createPage(page)
  }
}

文件介绍

• onCreatePage: Gatsby Node API 钩子，用于在构建过程中动态创建页面。
  • page.matchPath: 用于客户端路由匹配。

通过以上配置，您可以启动并配置 gatsby-auth-starter-aws-amplify 项目，实现用户认证和 AWS Amplify 的集成。