BotBotWeb 项目本地开发环境搭建指南

项目概述

BotBotWeb 是一个基于 Python 开发的 IRC 机器人管理系统，它提供了 Web 界面来管理和配置 IRC 机器人。本文将详细介绍如何在本地搭建 BotBotWeb 的开发环境。

环境准备

在开始安装前，请确保你的系统满足以下要求：

基础软件要求

1. Python 2.7：项目基于 Python 2.7 开发
2. PostgreSQL 数据库：需要安装 hStore 扩展
3. Go 语言：版本 1.2 或更高
4. Redis：用于缓存和消息队列

各系统安装方法

macOS 系统

# 安装 Homebrew (如未安装)
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

# 安装必要组件
brew install postgresql go redis

Ubuntu/Debian 系统

sudo apt-get update
sudo apt-get install postgresql-contrib postgresql-server-dev-all python-dev virtualenv golang-go redis-server

项目安装步骤

1. 创建虚拟环境

virtualenv botbot
source botbot/bin/activate

2. 获取项目代码并安装依赖

pip install -e git+https://github.com/BotBotMe/botbot-web.git#egg=botbot
cd $VIRTUAL_ENV/src/botbot
make dependencies

这个步骤会安装所有 Python 依赖并构建前端资源，可能需要几分钟时间。

3. 配置环境变量

编辑 .env 文件配置数据库连接等信息：

$EDITOR .env

默认配置适用于本地开发环境，如果 PostgreSQL 需要密码，需要修改 STORAGE_URL 配置。

使环境变量生效：

export $(cat .env | grep -v ^# | xargs)

4. 数据库初始化

createdb botbot
echo "create extension hstore" | psql botbot
manage.py migrate

5. 创建管理员账户

manage.py createsuperuser

按照提示输入用户名、邮箱和密码。

启动服务

1. 启动 Redis

redis-server

2. 启动应用服务

honcho start

或者如果你安装了 foreman：

foreman start

服务启动后，可以通过 http://localhost:8000 访问 Web 界面，使用之前创建的管理员账户登录。

测试与文档

运行测试

manage.py test accounts bots logs plugins

构建文档

pip install Sphinx
cd docs
make html

生成的 HTML 文档位于 docs/_build/html 目录。

后续步骤

1. 参考项目文档配置你的第一个 IRC 机器人
2. 如需在生产环境部署，请查阅生产环境部署指南
3. 如需参与开发，请阅读开发者文档

常见问题

1. 数据库连接失败：检查 .env 文件中的 STORAGE_URL 配置是否正确
2. 依赖安装失败：确保系统已安装所有必要的开发工具包
3. 服务启动失败：检查 Redis 是否已正确启动

通过以上步骤，你应该已经成功搭建了 BotBotWeb 的本地开发环境。现在可以开始探索和开发这个 IRC 机器人管理系统了。