MnemoAI 项目启动与配置教程

1. 项目目录结构及介绍

MnemoAI 项目采用以下目录结构来组织代码和资源：

mnemo/
├── Dockerfile          # Docker 容器构建文件
├── LICENSE            # 项目许可证文件
├── README.md          # 项目说明文件
├── Setup.sh           # 项目初始化脚本
├── config/            # 配置文件目录
│   ├── default.json   # 默认配置文件
│   └── ...
├── data/              # 数据存储目录
├── docs/              # 文档目录
├── models/            # 模型文件目录
│   ├── ...
│   └── ...
├── scripts/           # 脚本目录
│   ├── ...
│   └── ...
├── src/               # 源代码目录
│   ├── ...
│   └── ...
└── tests/             # 测试代码目录
    ├── ...
    └── ...

• Dockerfile：用于构建项目所需Docker镜像的文件。
• LICENSE：项目遵循的许可证信息。
• README.md：项目的基本信息和说明。
• Setup.sh：用于初始化项目环境的脚本。
• config/：存放项目配置文件的目录。
• data/：用于存储项目运行过程中产生或需要的数据文件。
• docs/：项目文档目录，包括用户手册、开发文档等。
• models/：存放模型文件和相关的模型代码。
• scripts/：存放项目运行过程中可能需要的辅助脚本。
• src/：项目的主要源代码目录。
• tests/：存放项目的测试代码。

2. 项目的启动文件介绍

项目的启动主要通过 Setup.sh 脚本进行。以下是 Setup.sh 脚本的主要功能：

#!/bin/bash

# 设置环境变量
export MNEMO_HOME=$(pwd)
export PATH=$PATH:$MNEMO_HOME/bin

# 安装依赖
pip install -r requirements.txt

# 初始化配置
cp config/default.json config/local.json

# 启动服务
python src/app.py

• 设置环境变量，方便后续命令调用。
• 使用 pip 安装项目依赖。
• 复制默认配置文件到本地配置文件，便于后续自定义配置。
• 启动项目服务。

用户可以通过在项目根目录下执行以下命令来启动项目：

chmod +x Setup.sh
./Setup.sh

3. 项目的配置文件介绍

项目的主要配置文件位于 config/default.json，以下是配置文件的示例内容：

{
    "server": {
        "host": "0.0.0.0",
        "port": 5000
    },
    "database": {
        "uri": "sqlite:///mnemo.db"
    },
    "features": {
        "enable_auth": true
    }
}

• server：定义了服务器的监听地址和端口。
• database：定义了数据库的连接信息。
• features：定义了项目功能特性，例如是否开启认证。

用户可以根据自己的需求，在 config/local.json 中修改这些配置项。如果需要修改配置，只需将 default.json 中的内容复制到 local.json 中，然后在 local.json 中进行修改即可。项目在启动时会读取 local.json 中的配置信息。