mirror of
https://github.com/xavidop/cardex.git
synced 2026-08-28 17:01:07 +00:00
1c873925b13db0a5564f3936c7d7e0050f1bfc31
Cardex - Pokémon Card Collection Manager
A modern web application for managing your Pokémon card collection with AI-powered card scanning and identification.
Features
- 🤖 AI Card Scanning: Use Gemini Vision to automatically identify Pokémon cards from photos
- 🔐 Secure Authentication: Firebase Authentication with email and Google login
- 📱 Responsive Design: Modern UI built with Next.js and Tailwind CSS
- 💾 Cloud Storage: Real-time data synchronization with Firestore
- ✏️ CRUD Operations: Create, read, update, and delete cards in your collection
- 🎯 Type Safety: Full TypeScript implementation for better development experience
Technology Stack
graph TB
subgraph "Frontend"
A[Next.js 15] --> B[React 18]
B --> C[TypeScript]
C --> D[Tailwind CSS]
D --> E[Radix UI Components]
B --> F[React Hook Form]
F --> G[Zod Validation]
end
subgraph "Backend Services"
H[Firebase Auth] --> I[Google Authentication]
J[Firestore Database] --> K[Real-time Updates]
L[Gemini AI] --> M[Vision API]
M --> N[Card Recognition]
end
subgraph "Development Tools"
O[Genkit AI Framework] --> P[AI Flow Management]
Q[ESLint] --> R[Code Quality]
S[PostCSS] --> T[CSS Processing]
end
A --> H
A --> J
A --> L
O --> L
Project Structure
src/
├── ai/
│ └── flows/
│ └── scan-pokemon-card.ts # AI card scanning logic
├── app/
│ ├── dashboard/
│ │ ├── collection/ # Card collection pages
│ │ └── scan/ # Card scanning page
│ └── page.tsx # Root page with auth routing
├── components/
│ ├── cards/
│ │ ├── CardForm.tsx # Reusable card form
│ │ ├── CardItem.tsx # Individual card display
│ │ └── CardScanner.tsx # AI scanning component
│ └── ui/ # Reusable UI components
├── hooks/
│ └── useAuth.tsx # Authentication hook
├── lib/
│ ├── firebase.ts # Firebase configuration
│ └── firestore.ts # Database operations
└── types/
└── index.ts # TypeScript type definitions
Getting Started
Prerequisites
- Node.js 18+
- Firebase project with Firestore and Authentication enabled
- Google AI API key for Gemini Vision
Installation
- Clone the repository:
git clone <repository-url>
cd cardex
- Install dependencies:
npm install
- Set up environment variables:
# Create .env.local file with:
NEXT_PUBLIC_FIREBASE_API_KEY=your_firebase_api_key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_project.firebaseapp.com
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_project.appspot.com
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id
GOOGLE_GENAI_API_KEY=your_gemini_api_key
- Run the development server:
npm run dev
- (Optional) Start the Genkit AI development server:
npm run genkit:dev
Usage
Card Scanning
- Navigate to the scan page
- Upload a photo of your Pokémon card
- Click "Scan Card" to identify the card using AI
- Review and edit the detected information
- Save the card to your collection
Collection Management
- View all your cards in a responsive grid layout
- Edit card details by clicking on any card
- Delete cards from your collection
- Cards are automatically sorted by last updated date
Database Structure
Firestore Collection: users/{userId}/pokemon_cards/{cardId}
├── name: string
├── set: string
├── rarity: string
├── imageDataUrl: string (base64 encoded image)
├── userId: string
├── createdAt: timestamp
└── updatedAt: timestamp
AI Integration
The app uses Google's Gemini Vision API through the Genkit framework to:
- Analyze uploaded card images
- Extract card name, set, and rarity information
- Provide structured data for user review and confirmation
Contributing
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Scripts
npm run dev- Start development server with Turbopacknpm run build- Build for productionnpm run start- Start production servernpm run lint- Run ESLintnpm run typecheck- Run TypeScript type checkingnpm run genkit:dev- Start Genkit AI development servernpm run genkit:watch- Start Genkit with file watching
Support
For support and questions, please open an issue in the repository.
Description
Languages
TypeScript
99.1%
CSS
0.6%
Nix
0.3%