Priceflow/docs/index.md

PriceFlow Documentation Index

Project Overview

• Project: PriceFlow
• Type: Multi-part (Frontend + Backend)
• Primary Languages: Python, JavaScript (React)
• Architecture: Client-Server / Service-Oriented
• Status: Brownfield Analysis (Quick Scan)

Quick Reference

Frontend (User Interface)

• Path: frontend/
• Tech: React 18, Vite, Tailwind CSS
• Documentation:
  • Architecture
  • Development Guide

Backend (API & Worker)

• Path: app/
• Tech: FastAPI, Python 3.12, SQLAlchemy
• Documentation:
  • Architecture
  • API Contracts
  • Data Models

Generated Documentation

• Project Overview
• Source Tree Analysis
• Integration Architecture
• Deployment Guide

Existing Documentation

• Amazon Scraper Details
• API Catalogues
• Analysis Report
• Startup Guide

Getting Started

1. Setup: Check the Deployment Guide to get running with Docker.
2. Develop: See the Development Guide for local setup instructions.
3. Explore: Review the Source Tree Analysis to understand the codebase structure.