开发环境搭建

本指南将帮助你在本地搭建 Loonflow 开发环境。

前置条件

开始前,请确保已安装以下组件:

  • Python 3.12.x(3.12 最新稳定版)

  • Node.js 22.x(22 最新稳定版)

  • Redis(用于生成工单流水号与 Celery 异步任务)

  • PostgreSQL(数据库)

后端配置

  1. 进入后端目录:

    cd backend
    
  2. 创建配置文件:

    settings/dev.py.sample 复制为 settings/config.py

    cp settings/dev.py.sample settings/config.py
    
  3. 配置 settings:

    编辑 settings/config.py 并更新以下配置:

    • 数据库配置(连接信息)

    • Redis 地址配置

    • 日志路径配置

    • 其他环境相关配置

  4. 创建并激活 Python 虚拟环境:

    python3.12 -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
    
  5. 安装依赖:

    pip install -r requirements/dev.txt
    
  6. 启动 Redis:

    Redis 用于:

    • Celery 异步任务(脚本执行、状态钩子、通知钩子)

    继续之前请确保 Redis 已运行。

  7. 初始化数据库:

    python manage.py makemigrations
    python manage.py migrate
    
  8. 创建超级用户:

    python manage.py createsuperuser
    
  9. 启动后端服务:

    python manage.py runserver
    

    后端访问地址:http://{your_ip}:8000

前端配置

  1. 进入前端目录:

    cd frontend
    
  2. 安装依赖:

    yarn install --immutable
    
  3. 启动前端开发服务器:

    yarn start
    

    前端访问地址:http://{your_ip}:3000

Celery Worker(可选)

本地开发可不启动 Celery worker,除非需要以下功能:

  • 脚本执行

  • 状态钩子

  • 通知钩子

如需上述功能,请启动 Celery worker:

  1. 进入后端目录:

    cd backend
    
  2. 启动 Celery worker:

    celery -A tasks worker -l info -Q loonflow
    

访问应用

当后端和前端都运行后,可通过以下地址访问应用:

http://{your_ip}:3000

The frontend is configured to proxy API requests to the backend at http://{your_ip}:8000.