Files
bttoxin-pipeline/README.md
2025-10-13 21:05:00 +08:00

56 lines
1.1 KiB
Markdown

# BtToxin Pipeline
Automated Bacillus thuringiensis toxin mining system with CI/CD integration.
## Quick Start (单机部署)
### Prerequisites
- Docker / Podman
- Python 3.10+
- Node.js 18+
### Development Setup
```bash
# 1. Clone and setup
git clone <your-repo>
cd bttoxin-pipeline
# 2. 使用 Makefile 初始化与启动(单机)
make setup
make start
# 3. 初始化数据库(创建表)
make db-init
# 4. 访问服务
# API: http://localhost:8000/docs
# Flower: http://localhost:5555
# Frontend:http://localhost:3000
# (可选) 本地开发
# Backend: uvicorn app.main:app --reload
# Frontend: npm run dev
```
## Architecture
Nginx (Reverse Proxy)
├── Frontend (Vue 3 Static)
└── Backend (FastAPI + Swagger)
├── PostgreSQL (SQLModel via SQLAlchemy)
├── Redis (Broker/Result)
├── Celery (Worker/Beat + Flower)
└── Docker Engine (BtToxin_Digger)
## Documentation
- API 文档: 浏览器打开 `http://localhost:8000/docs`
- 单机编排: `docker/docker-compose.yml`(唯一来源)
- 环境变量示例: `backend/.env.example`
- 常用命令: `make help`
## License
MIT License