first add
This commit is contained in:
44
README.md
44
README.md
@@ -2,7 +2,7 @@
|
||||
|
||||
Automated Bacillus thuringiensis toxin mining system with CI/CD integration.
|
||||
|
||||
## Quick Start
|
||||
## Quick Start (单机部署)
|
||||
|
||||
### Prerequisites
|
||||
|
||||
@@ -16,35 +16,39 @@ Automated Bacillus thuringiensis toxin mining system with CI/CD integration.
|
||||
git clone <your-repo>
|
||||
cd bttoxin-pipeline
|
||||
|
||||
# 2. Install dependencies
|
||||
cd backend && pip install -r requirements.txt
|
||||
cd ../frontend && npm install
|
||||
# 2. 使用 Makefile 初始化与启动(单机)
|
||||
make setup
|
||||
make start
|
||||
|
||||
# 3. Start services
|
||||
docker compose -f config/docker-compose.yml up -d
|
||||
# 3. 初始化数据库(创建表)
|
||||
make db-init
|
||||
|
||||
# 4. Run backend
|
||||
cd backend
|
||||
uvicorn app.main:app --reload
|
||||
# 4. 访问服务
|
||||
# API: http://localhost:8000/docs
|
||||
# Flower: http://localhost:5555
|
||||
# Frontend:http://localhost:3000
|
||||
|
||||
# 5. Run frontend
|
||||
cd frontend
|
||||
npm run dev
|
||||
# (可选) 本地开发
|
||||
# Backend: uvicorn app.main:app --reload
|
||||
# Frontend: npm run dev
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
Frontend (Vue 3) → Backend (FastAPI) → Celery → Docker (BtToxin_Digger)
|
||||
↓
|
||||
PostgreSQL + Redis
|
||||
↓
|
||||
S3/MinIO
|
||||
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 Documentation](docs/api.md)
|
||||
- [Deployment Guide](docs/deployment.md)
|
||||
- [Usage Guide](docs/usage.md)
|
||||
- API 文档: 浏览器打开 `http://localhost:8000/docs`
|
||||
- 单机编排: `docker/docker-compose.yml`(唯一来源)
|
||||
- 环境变量示例: `backend/.env.example`
|
||||
- 常用命令: `make help`
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user