Initial commit: BtToxin Pipeline project structure
This commit is contained in:
51
README.md
Normal file
51
README.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# 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. Install dependencies
|
||||
cd backend && pip install -r requirements.txt
|
||||
cd ../frontend && npm install
|
||||
|
||||
# 3. Start services
|
||||
docker compose -f config/docker-compose.yml up -d
|
||||
|
||||
# 4. Run backend
|
||||
cd backend
|
||||
uvicorn app.main:app --reload
|
||||
|
||||
# 5. Run frontend
|
||||
cd frontend
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
Frontend (Vue 3) → Backend (FastAPI) → Celery → Docker (BtToxin_Digger)
|
||||
↓
|
||||
PostgreSQL + Redis
|
||||
↓
|
||||
S3/MinIO
|
||||
|
||||
## Documentation
|
||||
|
||||
- [API Documentation](docs/api.md)
|
||||
- [Deployment Guide](docs/deployment.md)
|
||||
- [Usage Guide](docs/usage.md)
|
||||
|
||||
## License
|
||||
|
||||
MIT License
|
||||
Reference in New Issue
Block a user