CommCare HQ 项目技术文档

1. 安装指南

1.1 开发环境安装

要设置本地开发环境，请按照以下步骤操作：

1. 克隆项目仓库：

   git clone https://github.com/dimagi/commcare-hq.git
   cd commcare-hq
   

2. 安装依赖：

   pip install -r requirements/dev-requirements.txt
   

3. 配置数据库：
   • 创建数据库并配置 localsettings.py 文件。
4. 运行数据库迁移：

   python manage.py migrate
   

5. 启动开发服务器：

   python manage.py runserver
   

1.2 生产环境安装

对于生产环境的安装，建议使用 CommCare Cloud 工具包。该工具包提供了详细的部署和维护指南。

2. 项目使用说明

2.1 应用构建

CommCare HQ 提供了一个强大的应用构建器，允许用户创建复杂的、可定制的前线工作人员解决方案。用户可以通过图形界面设计表单、管理用户和移动工作人员、集成短信功能等。

2.2 数据收集与报告

项目支持通过 XForms 进行数据收集，并提供集成式的网页和邮件报告功能。用户可以轻松查看和管理收集到的数据。

2.3 案例管理

CommCare HQ 提供了案例管理功能，支持用户通过 Over-the-air (OTA) 方式恢复用户和案例数据。

3. 项目API使用文档

3.1 API概述

CommCare HQ 提供了一系列 API，用于与外部系统集成。API 支持用户管理、数据查询、表单提交等功能。

3.2 常用API

• 用户管理 API：用于创建、更新和删除用户。
• 数据查询 API：用于查询收集到的数据。
• 表单提交 API：用于提交 XForms 数据。

3.3 API 示例

以下是一个简单的 API 调用示例：

curl -X POST -H "Content-Type: application/json" -d '{"username": "testuser", "password": "testpass"}' http://localhost:8000/api/v0.5/users/

4. 项目安装方式

4.1 本地开发环境

如前所述，本地开发环境的安装步骤包括克隆仓库、安装依赖、配置数据库、运行迁移和启动服务器。

4.2 生产环境

生产环境的安装建议使用 CommCare Cloud 工具包，该工具包提供了详细的部署和维护指南。

---

通过以上文档，您应该能够顺利安装、使用和集成 CommCare HQ 项目。如有更多问题，欢迎访问我们的论坛获取帮助。