Biostar Central 技术文档

1. 安装指南

环境要求

• Python 3.6 或更高版本
• 推荐使用 conda 管理 Python 环境

安装步骤

1. 创建虚拟环境：

   conda create -y --name engine python=3.6
   

2. 激活虚拟环境：

   conda activate engine
   

3. 克隆项目代码：

   git clone https://github.com/ialbert/biostar-central.git
   

4. 进入项目目录：

   cd biostar-central
   

5. 安装依赖包：

   pip install -r conf/requirements.txt
   

至此，安装完成。

2. 项目的使用说明

运行演示服务器

• 运行 recipes 应用的演示版本：

  make recipes demo
  

• 运行 forum 应用的演示版本：

  make forum demo
  

访问 http://127.0.0.1:8000/ 查看站点。

默认用户

• 所有在 Django settings.py 模块中 ADMINS 属性列出的用户将获得管理员权限。
• 默认管理员用户名和密码均为 admin@localhost。
• 建议在公开部署时更改 DEFAULT_ADMIN_PASSWORD。

运行站点

• 初始化并运行 recipes 应用：

  make recipes serve
  

• 初始化并运行 forum 应用：

  make forum serve
  

3. 项目API使用文档

常用任务

• forum, recipes：选择要运行的应用，必须是任务列表中的第一个任务。
• demo：运行演示版本。
• init：初始化数据库模式。
• serve：在默认端口（localhost:8080）运行应用。
• save：将当前数据库内容保存为 JSON 文件。
• load：从 JSON 文件加载上次保存的数据库内容。
• reset：重置数据库（删除所有数据库内容）。
• hard_reset：运行 reset 并删除 media/spool 文件夹中的所有文件。

4. 项目安装方式

使用 conda 安装

• 创建虚拟环境：

  conda create -y --name engine python=3.6
  

• 激活虚拟环境：

  conda activate engine
  

• 克隆项目代码：

  git clone https://github.com/ialbert/biostar-central.git
  

• 进入项目目录：

  cd biostar-central
  

• 安装依赖包：

  pip install -r conf/requirements.txt
  

其他安装方式

• 可以使用其他 Python 环境管理工具（如 virtualenv）来替代 conda。

5. 测试

运行所有测试

make test

测试 recipes 应用

make recipes test

测试 forum 应用

make forum test

6. 文档

• recipes 应用文档：点击查看
• forum 应用文档：点击查看