Commit ff2472d4 authored by Vũ Hoàng Anh's avatar Vũ Hoàng Anh

docs: update README.md structure

parent a07c9f0c
# 🤖 Canifa AI Platform — Backend & Tools
# Canifa AI Platform — Backend & Tools
> **A unified AI ecosystem powering Canifa's fashion retail intelligence, content automation, and inventory monitoring.**
A unified AI ecosystem powering Canifa's fashion retail intelligence, content automation, and inventory monitoring.
This platform serves as the central hub for all AI-driven workflows at Canifa, integrating Large Language Models (Gemini, GPT) with real-time business data (PostgreSQL, StarRocks, SQLite) to provide actionable insights and automated content.
......@@ -46,83 +46,5 @@ This platform serves as the central hub for all AI-driven workflows at Canifa, i
## 🛠 Tech Stack
- **Backend**: [FastAPI](https://fastapi.tiangolo.com/) (Async Python 3.10+)
- **AI Framework**: [LangChain](https://www.langchain.com/) & [LangGraph](https://www.langchain.com/langgraph)
- **Database**:
- **Primary**: PostgreSQL (via SQLAlchemy 2.0)
- **Analytics**: StarRocks
- **Local Cache**: SQLite
- **Observability**: [Langfuse](https://langfuse.com/) (LLM Tracing & Feedback)
- **Deployment**: Docker, Uvicorn, Redis (Caching & Task Queue)
---
## 🚀 Getting Started
### Prerequisites
- Python 3.10 or higher
- Redis server (optional, for task queueing)
- Virtual Environment (`venv`)
### Installation
1. **Clone the repository**:
```bash
git clone https://github.com/your-org/chatbot-canifa-feedback.git
cd chatbot-canifa-feedback
```
2. **Set up virtual environment**:
```bash
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
```
3. **Install dependencies**:
```bash
pip install -r requirements.txt
```
4. **Environment Variables**:
Copy `.env.example` to `.env` and fill in your API keys (Gemini, OpenAI, Database credentials).
### Running the Server
```bash
cd backend
python server.py
```
The application will be available at `http://localhost:5000`.
---
## 📁 Project Structure
```
.
├── .agent/ # 🤖 AI Agent workflows & skills
├── backend/ # 🐍 FastAPI Backend
│ ├── api/ # 🛣️ REST API Routes
│ ├── common/ # 🛠️ Shared utilities (DB, Cache, etc.)
│ ├── static/ # 🌐 Frontend assets & Dashboards
│ └── server.py # 🚀 Entry point
├── frontend/ # ⚛️ Vite React Frontend (Paperclip board UI)
│ ├── src/ # 💻 Frontend logic, components, and hooks
│ └── public/ # 🖼️ Static assets
├── plan/ # 📋 SDLC Documentation (Ideas, Doings, Done)
├── public/ # 🖼️ Static assets & screenshots
└── README.md # 📖 This file
```
---
## 📜 API Documentation
Once the server is running, you can access the interactive Swagger documentation at:
- **Local**: `http://localhost:5000/docs`
- **ReDoc**: `http://localhost:5000/redoc`
---
<p align="center">
<strong>Built for Canifa AI Transformation</strong><br/>
<em>"Fashion meets Intelligence"</em>
</p>
- **Backend**: FastAPI (Async Python 3.10+)
- **AI Framework**: LangChain & LangGraph
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment