deckhearth/README.md

99 lines
2.8 KiB
Markdown
Raw Normal View History

# TCG Vault - Trading Card Collection Manager
A comprehensive trading card database system with OCR scanning, AI-powered deck building, and real-time pricing.
## Features
🃏 **Complete Card Database**
- Store and organize your entire trading card collection
- Track card conditions, quantities, and locations
- Support for multiple TCG formats (Magic: The Gathering, Pokémon, Yu-Gi-Oh!, etc.)
📸 **OCR Card Scanning**
- Scan physical cards using your camera or smartphone
- Automatic card recognition and data extraction
- Bulk scanning support for efficient collection entry
🤖 **AI-Powered Features**
- Intelligent deck building recommendations based on your collection
- Natural language queries for searching your database
- Meta analysis and card synergy suggestions
💰 **Real-time Pricing**
- Live price tracking from multiple sources
- Collection valuation and price alerts
- Historical price charts and market trends
🎨 **Modern Web Interface**
- Responsive design for desktop and mobile
- Drag-and-drop deck building
- Advanced filtering and search capabilities
## Tech Stack
- **Backend**: Python FastAPI with SQLAlchemy ORM
- **Database**: SQLite (production-ready, can scale to PostgreSQL)
- **Frontend**: React with TypeScript and Tailwind CSS
- **OCR**: OpenCV + Tesseract with cloud vision APIs
- **AI**: OpenAI GPT integration for intelligent features
- **Pricing**: TCGPlayer and MTGJSON API integration
## Quick Start
1. **Backend Setup**:
```bash
cd backend
pip install -r requirements.txt
uvicorn main:app --reload
```
2. **Frontend Setup**:
```bash
cd frontend
npm install
npm start
```
3. **Database Initialize**:
```bash
python backend/init_db.py
```
## Project Structure
```
tcg-vault/
├── backend/ # FastAPI backend
│ ├── app/
│ │ ├── models/ # SQLAlchemy models
│ │ ├── routers/ # API route handlers
│ │ ├── services/ # Business logic
│ │ └── utils/ # Utilities (OCR, AI, pricing)
│ ├── tests/ # Backend tests
│ └── requirements.txt
├── frontend/ # React frontend
│ ├── src/
│ │ ├── components/
│ │ ├── pages/
│ │ ├── services/ # API clients
│ │ └── utils/
│ └── package.json
├── docs/ # Documentation
└── docker-compose.yml # Container orchestration
```
## Development
This project is designed for easy development and deployment. See the individual README files in `backend/` and `frontend/` for detailed setup instructions.
## Contributing
1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request
## License
MIT License - feel free to use this project for your own collection management needs!