Shopify Django App示例项目技术文档

1. 安装指南

1.1 创建应用配置

1. 登录到 Shopify合作伙伴仪表板。
2. 导航到 你的应用。
3. 点击 创建应用。
4. 选择自定义应用或公共应用。
5. 填写应用名称。
6. 设置应用URL为 http://localhost:8000/。
7. 设置白名单重定向URL为 http://localhost:8000/shopify/finalize/。

完成后，你将获得API密钥和API密钥，这些将在后续步骤中使用。

1.2 设置环境

1. 将 .env.local 文件复制为 .env 文件，并填写 SHOPIFY_API_KEY 和 SHOPIFY_API_SECRET 字段：

   cp .env.local .env
   

2. 生成一个Django密钥并将其添加到 .env 文件中：

   python -c 'import random; print("".join([random.choice("abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)") for i in range(50)]))' >> .env
   

   对于PC用户： 在 GIT Bash 或 Windows Subsystem For Linux 中运行上述命令。或者，你可以使用Python解释器手动生成密钥：

   python
   

   在Python解释器中生成密钥并复制：

   >>> import random
   >>> print("".join([random.choice("abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)") for i in range(50)]))
   >>> exit()
   

3. [可选] 你可以将API版本和API范围的环境变量添加到 .env 文件中：

   • SHOPIFY_API_VERSION 默认值为 unstable。
   • SHOPIFY_API_SCOPE 默认值为 read_products,read_orders。

1.3 运行应用

1. 使用 pipenv 安装依赖并运行应用：

   pipenv install
   pipenv run python manage.py migrate
   pipenv run python manage.py runserver
   

2. 打开浏览器并访问 http://localhost:8000 查看示例应用。

2. 项目使用说明

2.1 项目结构

• shopify_app：处理认证的应用（可重用）。
• home：包含示例代码的应用，展示如何使用API（可修改或替换以创建你的Shopify应用）。
• shopify_django_app：用于服务此应用的项目文件。

2.2 功能概述

该项目简单展示了商店产品的基本信息和订单信息。你可以根据需要修改或替换 home 应用中的代码，以创建符合你需求的Shopify应用。

3. 项目API使用文档

3.1 认证

shopify_app 应用处理了与Shopify的认证流程。你需要在 .env 文件中配置 SHOPIFY_API_KEY 和 SHOPIFY_API_SECRET，以便应用能够正确与Shopify API进行交互。

3.2 API调用示例

在 home 应用中，你可以找到如何使用Shopify API的示例代码。通过这些示例，你可以了解如何获取商店的产品和订单信息。

4. 项目安装方式

4.1 依赖安装

使用 pipenv 安装项目依赖：

pipenv install

4.2 数据库迁移

运行数据库迁移命令：

pipenv run python manage.py migrate

4.3 启动服务器

启动Django开发服务器：

pipenv run python manage.py runserver

通过以上步骤，你可以成功安装并运行Shopify Django App示例项目。