hagamesai 的安装和配置教程

项目基础介绍

hagamesai 是一个开源项目，其目的是构建一个用于人机对战游戏场景、高级认知建模以及大型语言模型（LLM）服务的后端系统。该项目采用模块化、可扩展且安全的设计，为开发者和研究人员提供了一个强大的API接口。

编程语言

项目主要使用 Python 3.10+ 版本进行开发。

关键技术和框架

• 框架: FastAPI（一个高性能的异步Web框架）
• 数据库: PostgreSQL（支持JSONB数据类型）
• 异步ORM: SQLAlchemy 或 Tortoise ORM
• 任务队列: Celery（配合Redis或RabbitMQ）
• 大型语言模型SDK: OpenAI, Google AI
• 缓存: Redis（用于会话、限流和缓存）
• 容器化: Docker, Docker Compose
• 监控: Prometheus, Grafana
• 日志: ELK Stack 或 Grafana Loki

准备工作

在开始安装前，请确保您的系统中已经安装了以下环境和工具：

• Python 3.10 或更高版本
• Docker 和 Docker Compose（如果需要容器化部署）
• PostgreSQL 数据库

安装步骤

1. 克隆项目仓库到本地环境

   git clone https://github.com/hagameai/hagamesai.git
   cd hagamesai
   

2. 安装项目依赖

   uv pip install -r pyproject.toml
   

3. 配置环境变量

   将项目中的 .env.example 文件复制为 .env 文件，并根据实际情况填写相应的配置信息：

   cp .env.example .env
   

   需要配置的变量包括但不限于：

   • DATABASE_URL: PostgreSQL数据库的异步URL
   • SECRET_KEY: JWT的密钥
   • ALGORITHM: JWT的加密算法
   • ACCESS_TOKEN_EXPIRE_MINUTES: JWT的过期时间（分钟）

4. 运行项目

   使用以下命令启动项目：

   uvicorn main:app --reload
   

   项目启动后，您可以通过访问 http://localhost:8000/ 来检查健康状态，以及访问 http://localhost:8000/docs 查看OpenAPI文档。

以上步骤为hagamesai项目的基本安装和配置流程。项目详细文档和Roadmap可以在项目目录中的 docs/ 文件夹内找到。