Animal Shelter Manager 项目教程

1. 项目目录结构及介绍

Animal Shelter Manager (ASM) 项目的目录结构如下：

asm3/
├── doc/
├── import/
├── install/
│   └── deb/
├── pop/
├── reports/
├── scripts/
├── src/
├── unittest/
├── .babelrc
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── RELEASE
├── VERSION
├── changelog
├── package-lock.json
└── package.json

目录介绍：

• doc/: 包含项目的文档文件。
• import/: 用于导入数据的脚本和工具。
• install/deb/: 包含用于 Debian 系统安装的脚本和配置文件。
• pop/: 可能包含与 POP 协议相关的文件或脚本。
• reports/: 包含生成报告的脚本和模板。
• scripts/: 包含各种实用脚本，如配置文件示例等。
• src/: 项目的核心源代码目录。
• unittest/: 包含单元测试相关的文件和脚本。
• .babelrc: Babel 配置文件，用于 JavaScript 代码的转译。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目的开源许可证文件。
• Makefile: 用于构建和管理项目的 Makefile。
• README.md: 项目的介绍和使用说明。
• RELEASE: 项目的发布信息。
• VERSION: 项目的版本号。
• changelog: 项目的变更日志。
• package-lock.json: 锁定 npm 包版本的文件。
• package.json: 项目的 npm 配置文件。

2. 项目启动文件介绍

项目的启动文件主要位于 src/ 目录下。以下是一些关键的启动文件：

• src/main.py: 这是 ASM 项目的主入口文件。它负责启动 ASM 服务，并加载配置文件。
• src/cron.py: 这是一个定时任务脚本，用于执行每日的批处理任务，如数据更新和外部数据发布。

启动步骤：

1. 确保所有依赖项已安装（参考 README.md 中的依赖项列表）。
2. 在开发环境中，可以使用以下命令启动测试实例：

   make test
   

   这将启动一个运行在端口 5000 上的测试实例。

3. 项目配置文件介绍

ASM 项目的配置文件主要用于设置数据库连接、日志记录和其他系统参数。配置文件的位置和加载顺序如下：

1. 环境变量 ASM3_CONF: 如果设置了此环境变量，ASM 将使用该路径下的配置文件。
2. $INSTALL_DIR/asm3.conf: 安装目录下的配置文件。
3. $HOME/.asm3.conf: 用户主目录下的配置文件。
4. /etc/asm3.conf: 系统全局配置文件。

配置文件示例：

# /etc/asm3.conf

asm3_dbtype = POSTGRESQL  # 数据库类型 (POSTGRESQL, MYSQL, SQLITE)
asm3_dbhost = localhost   # 数据库服务器地址
asm3_dbport = 5432        # 数据库端口
asm3_dbusername = asm3    # 数据库用户名
asm3_dbpassword = password # 数据库密码
asm3_dbname = asm3_db     # 数据库名称 (如果是 SQLITE，则为文件路径)

配置文件加载顺序：

ASM 会按照上述顺序查找配置文件，直到找到一个有效的配置文件为止。确保配置文件中包含所有必需的参数，以便 ASM 能够正确连接到数据库并启动服务。

通过以上步骤，您可以成功启动并配置 Animal Shelter Manager 项目。