Letzshop Import Documentation

Welcome to the complete documentation for the Letzshop Import application - a comprehensive marketplace product import and management system built with FastAPI.

What is Letzshop Import?

Letzshop Import is a powerful web application that enables:

Product Management: Create, update, and manage product catalogs
Shop Management: Multi-shop support with individual configurations
CSV Import: Bulk import products from various marketplace formats
Stock Management: Track inventory across multiple locations
User Management: Role-based access control for different user types
Marketplace Integration: Import from various marketplace platforms

🚀 Get Started

Installation Guide - Set up the application
Quick Start - Get running in minutes
Configuration - Environment setup

📚 API Documentation

Interactive API Docs - Swagger UI for live testing
Alternative API Docs - ReDoc interface
API Overview - High-level API concepts
Authentication Guide - Security and auth flows

📖 User Guides

User Management - Managing users and roles
Product Management - Working with products
CSV Import - Bulk import workflows
Shop Setup - Configuring shops

🧪 Testing

Test Naming Conventions - Our testing standards
Running Tests - How to run the test suite

🔧 Development

Architecture - System design overview
Database Schema - Data model documentation
Contributing - How to contribute

🚢 Deployment

Docker Deployment - Containerized deployment
Production Setup - Production best practices

Architecture Overview

graph TB
    Client[Web Client/API Consumer]
    API[FastAPI Application]
    Auth[Authentication Service]
    Products[Product Service]
    Shops[Shop Service]
    Import[Import Service]
    DB[(PostgreSQL Database)]
    
    Client --> API
    API --> Auth
    API --> Products
    API --> Shops
    API --> Import
    Auth --> DB
    Products --> DB
    Shops --> DB
    Import --> DB

Key Features

=== "Product Management" - CRUD operations for products - GTIN validation and normalization - Price management with currency support - Category and attribute management - Bulk operations support

=== "Import System" - CSV file processing - Multiple marketplace format support - Validation and error reporting - Batch processing for large files - Import job tracking and status

=== "Multi-Shop Support" - Independent shop configurations - Shop-specific product associations - Inventory tracking per shop - Role-based shop access

=== "Security" - JWT-based authentication - Role-based access control (RBAC) - API key management - Input validation and sanitization - Rate limiting

Technology Stack

Backend: FastAPI, Python 3.10+
Database: PostgreSQL with SQLAlchemy ORM
Authentication: JWT tokens
Testing: pytest with comprehensive test suite
Documentation: MkDocs Material + FastAPI auto-docs
Deployment: Docker, Docker Compose

Getting Help

Issues: GitHub Issues
Discussions: GitHub Discussions
API Testing: Use the Swagger UI for interactive testing

Ready to get started? Head over to the Installation Guide!

4.0 KiB Raw Blame History