Curie 项目启动与配置教程

1. 项目目录结构及介绍

Curie 项目的目录结构如下所示，每个目录和文件都有其特定的作用：

Curie/
│
├── .gitignore          # Git 忽略文件，用于指定 Git 应该忽略的文件和目录
├── README.md           # 项目说明文件，包含项目介绍、使用方法和贡献指南
├── config/             # 配置文件目录
│   └── config.json     # 项目配置文件
├── docs/               # 文档目录，存放项目相关文档和教程
│   └── ...
├── scripts/            # 脚本目录，包含项目启动、部署等脚本
│   └── start.sh        # 项目启动脚本
├── src/                # 源代码目录
│   └── ...
└── test/               # 测试目录，包含单元测试和集成测试相关文件

• .gitignore：用于配置 Git 忽略策略，防止将不必要的文件提交到版本控制系统中。
• README.md：项目的基本信息，包括项目背景、功能介绍、安装步骤、使用说明等。
• config/：存放项目的配置文件，如数据库连接、API 密钥等。
• docs/：存放项目相关的文档和教程，方便用户和开发者查阅。
• scripts/：存放项目相关的脚本，如启动脚本、部署脚本等。
• src/：项目的核心代码目录，包含所有的源代码文件。
• test/：存放项目的测试代码，包括单元测试和集成测试。

2. 项目的启动文件介绍

项目的启动文件为 scripts/start.sh，该脚本用于启动项目。以下是启动脚本的内容：

#!/bin/bash

# 设置环境变量
export CURIE_CONFIG_PATH="./config/config.json"

# 启动项目
python src/main.py

该脚本做了以下几件事情：

• 设置环境变量 CURIE_CONFIG_PATH，指向配置文件 config.json 的路径。
• 使用 python 命令启动项目的主程序 src/main.py。

在运行该脚本前，请确保已经配置好了环境变量，并且有权限执行脚本。

3. 项目的配置文件介绍

项目的配置文件为 config/config.json，该文件包含了项目运行所需的基本配置信息。以下是配置文件的内容示例：

{
  "database": {
    "host": "localhost",
    "port": 3306,
    "user": "root",
    "password": "password",
    "dbname": "curie"
  },
  "api_key": "your_api_key_here"
}

配置文件中包含了以下配置项：

• database：数据库配置，包括数据库地址、端口、用户名、密码和数据库名称。
• api_key：API 密钥，用于项目与其他服务的交互认证。

在启动项目之前，请确保已经正确填写了配置文件中的各项信息。