CHT Core 项目教程

CHT Core 项目教程

cht-core The CHT Core Framework makes it faster to build responsive, offline-first digital health apps that equip health workers to provide better care in their communities. It is a central resource of the Community Health Toolkit. 项目地址: https://gitcode.com/gh_mirrors/ch/cht-core

1. 项目目录结构及介绍

CHT Core 项目的目录结构如下：

cht-core/
├── admin/
├── api/
├── config/
├── couchdb/
├── ddocs/
├── haproxy-healthcheck/
├── haproxy/
├── nginx/
├── patches/
├── release-notes/
├── scripts/
├── sentinel/
├── shared-libs/
├── tests/
├── webapp/
├── .browserslistrc
├── .dockerignore
├── .eslintrc
├── .gitattributes
├── .gitignore
├── .gitmodules
├── .mocharc.js
├── .sonarcloud.properties
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── Changes.md
├── DEVELOPMENT.md
├── LICENSE
├── README.md
├── SECURITY.md
├── TESTING.md
├── commitlint.config.js
├── package-lock.json
├── package.json
└── tsconfig.json

目录介绍

• admin/: 包含管理相关的文件和代码。
• api/: 包含API相关的文件和代码。
• config/: 包含项目的配置文件。
• couchdb/: 包含与CouchDB数据库相关的文件和代码。
• ddocs/: 包含设计文档（Design Documents）相关的文件和代码。
• haproxy-healthcheck/: 包含HAProxy健康检查相关的文件和代码。
• haproxy/: 包含HAProxy配置相关的文件和代码。
• nginx/: 包含Nginx配置相关的文件和代码。
• patches/: 包含补丁文件。
• release-notes/: 包含发布说明文件。
• scripts/: 包含各种脚本文件。
• sentinel/: 包含哨兵相关的文件和代码。
• shared-libs/: 包含共享库文件。
• tests/: 包含测试相关的文件和代码。
• webapp/: 包含Web应用程序的文件和代码。

2. 项目启动文件介绍

CHT Core 项目的启动文件主要集中在 scripts/ 目录下。以下是一些关键的启动脚本：

• scripts/start.sh: 这是一个启动脚本，用于启动整个项目。它会调用其他必要的脚本来启动各个组件，如CouchDB、HAProxy、Nginx等。
• scripts/setup.sh: 这是一个设置脚本，用于初始化项目环境，包括安装依赖、配置数据库等。
• scripts/test.sh: 这是一个测试脚本，用于运行项目的单元测试和集成测试。

3. 项目的配置文件介绍

CHT Core 项目的配置文件主要集中在 config/ 目录下。以下是一些关键的配置文件：

• config/default.json: 这是项目的默认配置文件，包含了项目的各种默认设置，如数据库连接、API端口、日志级别等。
• config/production.json: 这是生产环境的配置文件，通常会覆盖默认配置文件中的某些设置，以适应生产环境的需求。
• config/development.json: 这是开发环境的配置文件，通常会覆盖默认配置文件中的某些设置，以适应开发环境的需求。
• config/test.json: 这是测试环境的配置文件，通常会覆盖默认配置文件中的某些设置，以适应测试环境的需求。

此外，还有一些全局配置文件，如：

• package.json: 这是Node.js项目的配置文件，包含了项目的依赖、脚本命令等信息。
• tsconfig.json: 这是TypeScript项目的配置文件，包含了TypeScript编译器的设置。
• .eslintrc: 这是ESLint的配置文件，用于代码风格检查。

通过这些配置文件，开发者可以灵活地调整项目的运行环境，以适应不同的需求。

cht-core The CHT Core Framework makes it faster to build responsive, offline-first digital health apps that equip health workers to provide better care in their communities. It is a central resource of the Community Health Toolkit. 项目地址: https://gitcode.com/gh_mirrors/ch/cht-core