mirror of
https://github.com/R0m1k3/Priceflow.git
synced 2026-10-11 17:29:14 +02:00
49 lines
1.5 KiB
Markdown
49 lines
1.5 KiB
Markdown
# 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](./architecture-frontend.md)
|
|
- [Development Guide](./development-guide.md)
|
|
|
|
### Backend (API & Worker)
|
|
|
|
- **Path:** `app/`
|
|
- **Tech:** FastAPI, Python 3.12, SQLAlchemy
|
|
- **Documentation:**
|
|
- [Architecture](./architecture-app.md)
|
|
- [API Contracts](./api-contracts-app.md)
|
|
- [Data Models](./data-models-app.md)
|
|
|
|
## Generated Documentation
|
|
|
|
- [Project Overview](./project-overview.md)
|
|
- [Source Tree Analysis](./source-tree-analysis.md)
|
|
- [Integration Architecture](./integration-architecture.md)
|
|
- [Deployment Guide](./deployment-guide.md)
|
|
|
|
## Existing Documentation
|
|
|
|
- [Amazon Scraper Details](./AMAZON_SCRAPER.md)
|
|
- [API Catalogues](./API_CATALOGUES.md)
|
|
- [Analysis Report](../RAPPORT_ANALYSE.md)
|
|
- [Startup Guide](../DEMARRAGE.md)
|
|
|
|
## Getting Started
|
|
|
|
1. **Setup**: Check the [Deployment Guide](./deployment-guide.md) to get running with Docker.
|
|
2. **Develop**: See the [Development Guide](./development-guide.md) for local setup instructions.
|
|
3. **Explore**: Review the [Source Tree Analysis](./source-tree-analysis.md) to understand the codebase structure.
|